com.sitewhere.spi.asset

Interface IAssetManagement

All Superinterfaces:

ILifecycleComponent, ITenantLifecycleComponent

public interface IAssetManagement
extends ITenantLifecycleComponent

Asset management interface implemented by datastores that can store assets.

Method Summary

Modifier and Type	Method and Description
IAssetCategory	createAssetCategory(IAssetCategoryCreateRequest request) Create a new asset category.
IHardwareAsset	createHardwareAsset(java.lang.String categoryId, IHardwareAssetCreateRequest request) Create a new IHardwareAsset.
ILocationAsset	createLocationAsset(java.lang.String categoryId, ILocationAssetCreateRequest request) Create a new ILocationAsset.
IPersonAsset	createPersonAsset(java.lang.String categoryId, IPersonAssetCreateRequest request) Create a new IPersonAsset.
IAsset	deleteAsset(java.lang.String categoryId, java.lang.String assetId) Delete the asset with the given id in the given category.
IAssetCategory	deleteAssetCategory(java.lang.String categoryId) Delete an asset category and all contained assets.
IAsset	getAsset(java.lang.String categoryId, java.lang.String assetId) Get the asset for the given id in the given category.
IAssetCategory	getAssetCategory(java.lang.String categoryId) Get an asset category by id.
ISearchResults<IAssetCategory>	listAssetCategories(ISearchCriteria criteria) List asset categories.
ISearchResults<IAsset>	listAssets(java.lang.String categoryId, ISearchCriteria criteria) List assets in a category that meet the given criteria.
IAssetCategory	updateAssetCategory(java.lang.String categoryId, IAssetCategoryCreateRequest request) Update an existing asset category.
IHardwareAsset	updateHardwareAsset(java.lang.String categoryId, java.lang.String assetId, IHardwareAssetCreateRequest request) Update an existing hardware asset.
ILocationAsset	updateLocationAsset(java.lang.String categoryId, java.lang.String assetId, ILocationAssetCreateRequest request) Update an existing location asset.
IPersonAsset	updatePersonAsset(java.lang.String categoryId, java.lang.String assetId, IPersonAssetCreateRequest request) Update an existing person asset.

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ITenantLifecycleComponent

getTenant, setTenant

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent

canPause, findComponentsOfType, getComponentId, getComponentName, getComponentType, getCreatedDate, getLifecycleComponents, getLifecycleError, getLifecycleStatus, getLogger, initialize, initializeNestedComponent, lifecycleInitialize, lifecyclePause, lifecycleStart, lifecycleStop, lifecycleStop, logState, pause, start, startNestedComponent, stop, stop

Method Detail

createAssetCategory

IAssetCategory createAssetCategory(IAssetCategoryCreateRequest request)
                            throws SiteWhereException

Create a new asset category.

Parameters:

request -

Returns:

Throws:

SiteWhereException

getAssetCategory

IAssetCategory getAssetCategory(java.lang.String categoryId)
                         throws SiteWhereException

Get an asset category by id.

Parameters:

categoryId -

Returns:

Throws:

SiteWhereException

updateAssetCategory

IAssetCategory updateAssetCategory(java.lang.String categoryId,
                                   IAssetCategoryCreateRequest request)
                            throws SiteWhereException

Update an existing asset category.

Parameters:

categoryId -

request -

Returns:

Throws:

SiteWhereException

listAssetCategories

ISearchResults<IAssetCategory> listAssetCategories(ISearchCriteria criteria)
                                            throws SiteWhereException

List asset categories.

Parameters:

criteria -

Returns:

Throws:

SiteWhereException

deleteAssetCategory

IAssetCategory deleteAssetCategory(java.lang.String categoryId)
                            throws SiteWhereException

Delete an asset category and all contained assets.

Parameters:

categoryId -

Returns:

Throws:

SiteWhereException

createPersonAsset

IPersonAsset createPersonAsset(java.lang.String categoryId,
                               IPersonAssetCreateRequest request)
                        throws SiteWhereException

Create a new IPersonAsset.

Parameters:

categoryId -

request -

Returns:

Throws:

SiteWhereException

updatePersonAsset

IPersonAsset updatePersonAsset(java.lang.String categoryId,
                               java.lang.String assetId,
                               IPersonAssetCreateRequest request)
                        throws SiteWhereException

Update an existing person asset.

Parameters:

categoryId -

assetId -

request -

Returns:

Throws:

SiteWhereException

createHardwareAsset

IHardwareAsset createHardwareAsset(java.lang.String categoryId,
                                   IHardwareAssetCreateRequest request)
                            throws SiteWhereException

Create a new IHardwareAsset.

Parameters:

categoryId -

request -

Returns:

Throws:

SiteWhereException

updateHardwareAsset

IHardwareAsset updateHardwareAsset(java.lang.String categoryId,
                                   java.lang.String assetId,
                                   IHardwareAssetCreateRequest request)
                            throws SiteWhereException

Update an existing hardware asset.

Parameters:

categoryId -

assetId -

request -

Returns:

Throws:

SiteWhereException

createLocationAsset

ILocationAsset createLocationAsset(java.lang.String categoryId,
                                   ILocationAssetCreateRequest request)
                            throws SiteWhereException

Create a new ILocationAsset.

Parameters:

categoryId -

request -

Returns:

Throws:

SiteWhereException

updateLocationAsset

ILocationAsset updateLocationAsset(java.lang.String categoryId,
                                   java.lang.String assetId,
                                   ILocationAssetCreateRequest request)
                            throws SiteWhereException

Update an existing location asset.

Parameters:

categoryId -

assetId -

request -

Returns:

Throws:

SiteWhereException

getAsset

IAsset getAsset(java.lang.String categoryId,
                java.lang.String assetId)
         throws SiteWhereException

Get the asset for the given id in the given category.

Parameters:

categoryId -

assetId -

Returns:

Throws:

SiteWhereException

deleteAsset

IAsset deleteAsset(java.lang.String categoryId,
                   java.lang.String assetId)
            throws SiteWhereException

Delete the asset with the given id in the given category.

Parameters:

categoryId -

assetId -

Returns:

Throws:

SiteWhereException

listAssets

ISearchResults<IAsset> listAssets(java.lang.String categoryId,
                                  ISearchCriteria criteria)
                           throws SiteWhereException

List assets in a category that meet the given criteria.

Parameters:

categoryId -

criteria -

Returns:

Throws:

SiteWhereException