com.sitewhere.spi.asset

Interface IAssetModuleManager

All Superinterfaces:

ILifecycleComponent, ITenantLifecycleComponent

public interface IAssetModuleManager
extends ITenantLifecycleComponent

Interface for interacting with the asset module manager.

Method Summary

Modifier and Type	Method and Description
IAsset	getAssetById(java.lang.String assetModuleId, java.lang.String id) Finds an asset in a given module.
IAssetModule<?>	getModule(java.lang.String assetModuleId) Get asset module by unique id.
java.util.List<IAssetModule<?>>	listModules() Get the list of asset modules.
void	onAssetCategoryAdded(IAssetCategory category, ILifecycleProgressMonitor monitor) Called when an asset category is added.
void	onAssetCategoryRemoved(IAssetCategory category, ILifecycleProgressMonitor monitor) Called when an asset category is removed.
void	refreshModules(ILifecycleProgressMonitor monitor) Calls the refresh method on all asset modules.
java.util.List<? extends IAsset>	search(java.lang.String assetModuleId, java.lang.String criteria) Search an asset module for assets matching the given criteria.
void	setAssetManagement(IAssetManagement assetManagement) Set asset management implementation.

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

setAssetManagement

void setAssetManagement(IAssetManagement assetManagement)

Set asset management implementation.

Parameters:

assetManagement -

getModule

IAssetModule<?> getModule(java.lang.String assetModuleId)
                   throws SiteWhereException

Get asset module by unique id.

Parameters:

assetModuleId -

Returns:

Throws:

SiteWhereException

listModules

java.util.List<IAssetModule<?>> listModules()
                                     throws SiteWhereException

Get the list of asset modules.

Returns:

Throws:

SiteWhereException

refreshModules

void refreshModules(ILifecycleProgressMonitor monitor)
             throws SiteWhereException

Calls the refresh method on all asset modules.

Parameters:

monitor -

Throws:

SiteWhereException

onAssetCategoryAdded

void onAssetCategoryAdded(IAssetCategory category,
                          ILifecycleProgressMonitor monitor)
                   throws SiteWhereException

Called when an asset category is added.

Parameters:

category -

monitor -

Throws:

SiteWhereException

onAssetCategoryRemoved

void onAssetCategoryRemoved(IAssetCategory category,
                            ILifecycleProgressMonitor monitor)
                     throws SiteWhereException

Called when an asset category is removed.

Parameters:

category -

monitor -

Throws:

SiteWhereException

getAssetById

IAsset getAssetById(java.lang.String assetModuleId,
                    java.lang.String id)
             throws SiteWhereException

Finds an asset in a given module.

Parameters:

assetModuleId -

id -

Returns:

Throws:

SiteWhereException

search

java.util.List<? extends IAsset> search(java.lang.String assetModuleId,
                                        java.lang.String criteria)
                                 throws SiteWhereException

Search an asset module for assets matching the given criteria.

Parameters:

assetModuleId -

criteria -

Returns:

Throws:

SiteWhereException