com.cumulocity.sdk.client.inventory

Interface InventoryApi

All Known Implementing Classes:

InventoryApiImpl

public interface InventoryApi

API for creating, and retrieving managed objects resources from the platform. Delete and update functionality is implemented on the returned managed object.

Method Summary

Modifier and Type	Method and Description
ManagedObjectRepresentation	create(ManagedObjectRepresentation managedObject) Creates managed object in the platform.
void	delete(com.cumulocity.model.idtype.GId id) Deletes the Managed Object from the Cumulocity Server.
void	deleteCascade(com.cumulocity.model.idtype.GId id) Deletes the Managed Object and all child devices and child assets recursively from the Cumulocity Server.
ManagedObjectRepresentation	get(com.cumulocity.model.idtype.GId id) Returns the Managed Object of the Resource.
ManagedObjectRepresentation	get(com.cumulocity.model.idtype.GId id, QueryParam... params) Returns the Managed Object of the Resource.
ManagedObject	getManagedObject(com.cumulocity.model.idtype.GId gid) Deprecated.
ManagedObject	getManagedObjectApi(com.cumulocity.model.idtype.GId gid) Gets managed object resource by id.
ManagedObjectCollection	getManagedObjects() Gets the all the managed object in the platform
ManagedObjectCollection	getManagedObjectsByFilter(InventoryFilter filter) Gets the managed objects from the platform based on specified filter.
ManagedObjectCollection	getManagedObjectsByListOfIds(List<com.cumulocity.model.idtype.GId> ids) Deprecated.
SupportedMeasurementsRepresentation	getSupportedMeasurements(com.cumulocity.model.idtype.GId id) Returns supported measurements of the Managed Object specified by its id
SupportedSeriesRepresentation	getSupportedSeries(com.cumulocity.model.idtype.GId id) Returns supported series of the Managed Object specified by its id
ManagedObjectRepresentation	update(ManagedObjectRepresentation managedObjectRepresentation) This update the ManagedObject for the operationCollection.

Method Detail

get

ManagedObjectRepresentation get(com.cumulocity.model.idtype.GId id)
                         throws SDKException

Returns the Managed Object of the Resource.

Parameters:

id - Managed Object General Identifier

Returns:

ManagedObjectRepresentation

Throws:

SDKException - if query failed

get

ManagedObjectRepresentation get(com.cumulocity.model.idtype.GId id,
                                QueryParam... params)
                         throws SDKException

Returns the Managed Object of the Resource. Using additional query params e.g. withChildren=false to optimize access time.

Parameters:

id - Managed Object General Identifier

params - query parameters

Returns:

ManagedObjectRepresentation

Throws:

SDKException - if query failed

delete

void delete(com.cumulocity.model.idtype.GId id)
     throws SDKException

Deletes the Managed Object from the Cumulocity Server.

Parameters:

id - Managed Object General Identifier

Throws:

SDKException - if the managed object could not be deleted

deleteCascade

void deleteCascade(com.cumulocity.model.idtype.GId id)
            throws SDKException

Deletes the Managed Object and all child devices and child assets recursively from the Cumulocity Server.

Parameters:

id - Managed Object General Identifier

Throws:

SDKException - if the managed object could not be deleted

update

ManagedObjectRepresentation update(ManagedObjectRepresentation managedObjectRepresentation)
                            throws SDKException

This update the ManagedObject for the operationCollection. Cannot update the ID.

Parameters:

managedObjectRepresentation - managed object representation

Returns:

ManagedObjectRepresentation updated ManagedObject.

Throws:

SDKException - if the managed object could not be updated

getManagedObjectApi

ManagedObject getManagedObjectApi(com.cumulocity.model.idtype.GId gid)
                           throws SDKException

Gets managed object resource by id. To get the managed object representation you have to call get() on the returned resource.

Parameters:

gid - id of the managed object to search for

Returns:

the managed object resource associated with the given id

Throws:

SDKException - if the query failed

create

ManagedObjectRepresentation create(ManagedObjectRepresentation managedObject)
                            throws SDKException

Creates managed object in the platform. The id of the managed object must not be set, since it will be generated by the platform

Parameters:

managedObject - the managed object to be created

Returns:

the created managed object with the generated id

Throws:

SDKException - if the managed object could not be created

getManagedObjects

ManagedObjectCollection getManagedObjects()
                                   throws SDKException

Gets the all the managed object in the platform

Returns:

collection of managed objects with paging functionality

Throws:

SDKException - if the query failed

getManagedObjectsByFilter

ManagedObjectCollection getManagedObjectsByFilter(InventoryFilter filter)
                                           throws SDKException

Gets the managed objects from the platform based on specified filter. Query based on type and fragmentType is not supported.

Parameters:

filter - the filter criteria(s)

Returns:

collection of managed objects matched by the filter with paging functionality

Throws:

SDKException - if the query failed

IllegalArgumentException - if both type and fragmentType are specified in the filter

getSupportedMeasurements

SupportedMeasurementsRepresentation getSupportedMeasurements(com.cumulocity.model.idtype.GId id)
                                                      throws SDKException

Returns supported measurements of the Managed Object specified by its id

Parameters:

id - id of the managed object to search for

Returns:

SupportedMeasurementsRepresentation

Throws:

SDKException - if managed object does not exists

getSupportedSeries

SupportedSeriesRepresentation getSupportedSeries(com.cumulocity.model.idtype.GId id)
                                          throws SDKException

Returns supported series of the Managed Object specified by its id

Parameters:

id - id of the managed object to search for

Returns:

SupportedSeriesRepresentation

Throws:

SDKException - if managed object does not exists

getManagedObjectsByListOfIds

@Deprecated
ManagedObjectCollection getManagedObjectsByListOfIds(List<com.cumulocity.model.idtype.GId> ids)
                                                          throws SDKException

Deprecated.

Gets the managed objects from the platform based on the given ids

Parameters:

ids - the list of ids of the managed objects to search for

Returns:

collection of managed objects matched in order of the given ids

Throws:

SDKException - if the query failed

getManagedObject

@Deprecated
ManagedObject getManagedObject(com.cumulocity.model.idtype.GId gid)
                                    throws SDKException

Deprecated.

Gets managed object resource by id. To get the managed object representation you have to call get() on the returned resource.

Parameters:

gid - id of the managed object to search for

Returns:

the managed object resource associated with the given id

Throws:

SDKException - if the query failed