com.sitewhere.spi.asset

Interface IAssetModule<T extends IAsset>

All Superinterfaces:

IAssetCategory, ILifecycleComponent, java.io.Serializable

public interface IAssetModule<T extends IAsset>
extends ILifecycleComponent, IAssetCategory

Interface for a module that provides access to assets of a given type.

Method Summary

Modifier and Type	Method and Description
T	getAsset(java.lang.String id) Get an asset by unique id.
void	putAsset(java.lang.String id, T asset) Create or update an asset.
ICommandResponse	refresh(ILifecycleProgressMonitor monitor) Refresh any cached data in the module.
void	removeAsset(java.lang.String id) Remove an existing asset.
java.util.List<T>	search(java.lang.String criteria) Search for all assets of a given type that meet the criteria.

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

Methods inherited from interface com.sitewhere.spi.asset.IAssetCategory

getAssetType, getId, getName

Method Detail

getAsset

T getAsset(java.lang.String id)
    throws SiteWhereException

Get an asset by unique id.

Parameters:

id -

Returns:

Throws:

SiteWhereException

putAsset

void putAsset(java.lang.String id,
              T asset)
       throws SiteWhereException

Create or update an asset.

Parameters:

id -

asset -

Throws:

SiteWhereException

removeAsset

void removeAsset(java.lang.String id)
          throws SiteWhereException

Remove an existing asset.

Parameters:

id -

Throws:

SiteWhereException

search

java.util.List<T> search(java.lang.String criteria)
                  throws SiteWhereException

Search for all assets of a given type that meet the criteria.

Parameters:

criteria -

Returns:

Throws:

SiteWhereException

refresh

ICommandResponse refresh(ILifecycleProgressMonitor monitor)
                  throws SiteWhereException

Refresh any cached data in the module.

Parameters:

monitor -

Returns:

Throws:

SiteWhereException