com.sitewhere.spi.device

Interface IDeviceManagement

All Superinterfaces:

ILifecycleComponent, ITenantLifecycleComponent

public interface IDeviceManagement
extends ITenantLifecycleComponent

Interface for device management operations.

Method Summary

Modifier and Type	Method and Description
java.util.List<IDeviceGroupElement>	addDeviceGroupElements(java.lang.String groupToken, java.util.List<IDeviceGroupElementCreateRequest> elements, boolean ignoreDuplicates) Add elements to a device group.
IBatchOperation	createBatchCommandInvocation(IBatchCommandInvocationRequest request) Creates an ISearchResults that will invoke a command on multiple devices.
IBatchOperation	createBatchOperation(IBatchOperationCreateRequest request) Creates an IBatchOperation to perform an operation on multiple devices.
IDevice	createDevice(IDeviceCreateRequest device) Create a new device.
IDeviceAssignment	createDeviceAssignment(IDeviceAssignmentCreateRequest request) Create a new device assignment.
IDeviceCommand	createDeviceCommand(IDeviceSpecification spec, IDeviceCommandCreateRequest request) Creates a device command associated with an existing device specification.
IDevice	createDeviceElementMapping(java.lang.String hardwareId, IDeviceElementMapping mapping) Create an IDeviceElementMapping for a nested device.
IDeviceGroup	createDeviceGroup(IDeviceGroupCreateRequest request) Create a new device group.
IDeviceSpecification	createDeviceSpecification(IDeviceSpecificationCreateRequest request) Create a new device specification.
IDeviceStream	createDeviceStream(java.lang.String assignmentToken, IDeviceStreamCreateRequest request) Create a new IDeviceStream associated with an assignment.
ISite	createSite(ISiteCreateRequest request) Create a site based on the given input.
IZone	createZone(ISite site, IZoneCreateRequest request) Create a new zone.
IBatchOperation	deleteBatchOperation(java.lang.String token, boolean force) Deletes a batch operation and its elements.
IDevice	deleteDevice(java.lang.String hardwareId, boolean force) Delete an existing device.
IDeviceAssignment	deleteDeviceAssignment(java.lang.String token, boolean force) Delete a device assignment.
IDeviceCommand	deleteDeviceCommand(java.lang.String token, boolean force) Delete an existing device command.
IDevice	deleteDeviceElementMapping(java.lang.String hardwareId, java.lang.String path) Delete an exising IDeviceElementMapping from a device.
IDeviceGroup	deleteDeviceGroup(java.lang.String token, boolean force) Delete a device group.
IDeviceSpecification	deleteDeviceSpecification(java.lang.String token, boolean force) Delete an existing device specification.
ISite	deleteSite(java.lang.String siteToken, boolean force) Delete a site based on unique site token.
IZone	deleteZone(java.lang.String zoneToken, boolean force) Delete a zone given its unique token.
IDeviceAssignment	endDeviceAssignment(java.lang.String token) Ends a device assignment.
IBatchOperation	getBatchOperation(java.lang.String token) Get an IBatchOperation by unique token.
IDeviceAssignment	getCurrentDeviceAssignment(IDevice device) Gets the current assignment for a device.
IDeviceAssignment	getDeviceAssignmentByToken(java.lang.String token) Get a device assignment by unique token.
ISearchResults<IDeviceAssignment>	getDeviceAssignmentHistory(java.lang.String hardwareId, ISearchCriteria criteria) Get the device assignment history for a given device.
ISearchResults<IDeviceAssignment>	getDeviceAssignmentsForAsset(java.lang.String assetModuleId, java.lang.String assetId, IAssignmentsForAssetSearchCriteria criteria) Get a list of device assignments associated with a given asset.
ISearchResults<IDeviceAssignment>	getDeviceAssignmentsForSite(java.lang.String siteToken, IAssignmentSearchCriteria criteria) Get a list of device assignments for a site.
ISearchResults<IDeviceAssignment>	getDeviceAssignmentsWithLastInteraction(java.lang.String siteToken, IDateRangeSearchCriteria criteria) Finds all device assignments for a site with a last interaction date in the given date range.
IDevice	getDeviceByHardwareId(java.lang.String hardwareId) Gets a device by unique hardware id.
IDeviceCommand	getDeviceCommandByToken(java.lang.String token) Get a device command by unique token.
IDevice	getDeviceForAssignment(IDeviceAssignment assignment) Get the device associated with an assignment.
IDeviceGroup	getDeviceGroup(java.lang.String token) Get a device network by unique token.
IDeviceSpecification	getDeviceSpecificationByToken(java.lang.String token) Get a device specification by unique token.
IDeviceStream	getDeviceStream(java.lang.String assignmentToken, java.lang.String streamId) Get an exsiting IDeviceStream for an assignment based on unique stream id.
ISearchResults<IDeviceAssignment>	getMissingDeviceAssignments(java.lang.String siteToken, ISearchCriteria criteria) Find all device assignments that have been marked missing by the presence manager.
ISite	getSiteByToken(java.lang.String token) Get a site by unique token.
ISite	getSiteForAssignment(IDeviceAssignment assignment) Get the site associated with an assignment.
IZone	getZone(java.lang.String zoneToken) Get a zone by its unique token.
ISearchResults<IBatchElement>	listBatchElements(java.lang.String batchToken, IBatchElementSearchCriteria criteria) Lists elements for an IBatchOperation that meet the given criteria.
ISearchResults<IBatchOperation>	listBatchOperations(boolean includeDeleted, ISearchCriteria criteria) List batch operations based on the given criteria.
java.util.List<IDeviceCommand>	listDeviceCommands(java.lang.String specToken, boolean includeDeleted) List device command objects associated with a device specification.
ISearchResults<IDeviceGroupElement>	listDeviceGroupElements(java.lang.String groupToken, ISearchCriteria criteria) List device group elements that meet the given criteria.
ISearchResults<IDeviceGroup>	listDeviceGroups(boolean includeDeleted, ISearchCriteria criteria) List device groups.
ISearchResults<IDeviceGroup>	listDeviceGroupsWithRole(java.lang.String role, boolean includeDeleted, ISearchCriteria criteria) Lists all device groups that have the given role.
ISearchResults<IDevice>	listDevices(boolean includeDeleted, IDeviceSearchCriteria criteria) List devices that meet the given criteria.
ISearchResults<IDeviceSpecification>	listDeviceSpecifications(boolean includeDeleted, ISearchCriteria criteria) List device specifications that match the search criteria.
ISearchResults<IDeviceStream>	listDeviceStreams(java.lang.String assignmentToken, ISearchCriteria criteria) List device streams for the assignment that meet the given criteria.
ISearchResults<ISite>	listSites(ISearchCriteria criteria) Get a list of all sites.
ISearchResults<IZone>	listZones(java.lang.String siteToken, ISearchCriteria criteria) Get a list of all zones associated with a Site.
java.util.List<IDeviceGroupElement>	removeDeviceGroupElements(java.lang.String groupToken, java.util.List<IDeviceGroupElementCreateRequest> elements) Remove selected elements from a device group.
IBatchElement	updateBatchElement(java.lang.String operationToken, long index, IBatchElementUpdateRequest request) Updates an existing batch operation element.
IBatchOperation	updateBatchOperation(java.lang.String token, IBatchOperationUpdateRequest request) Update an existing IBatchOperation.
IDevice	updateDevice(java.lang.String hardwareId, IDeviceCreateRequest request) Update device information.
IDeviceAssignment	updateDeviceAssignmentMetadata(java.lang.String token, IMetadataProvider metadata) Update metadata associated with a device assignment.
IDeviceAssignment	updateDeviceAssignmentState(java.lang.String token, IDeviceAssignmentState state) Updates the current state of a device assignment.
IDeviceAssignment	updateDeviceAssignmentStatus(java.lang.String token, DeviceAssignmentStatus status) Update the status of an existing device assignment.
IDeviceCommand	updateDeviceCommand(java.lang.String token, IDeviceCommandCreateRequest request) Update an existing device command.
IDeviceGroup	updateDeviceGroup(java.lang.String token, IDeviceGroupCreateRequest request) Update an existing device group.
IDeviceSpecification	updateDeviceSpecification(java.lang.String token, IDeviceSpecificationCreateRequest request) Update an existing device specification.
ISite	updateSite(java.lang.String siteToken, ISiteCreateRequest request) Update information for a site.
IZone	updateZone(java.lang.String token, IZoneCreateRequest request) Update an existing zone.

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

createDeviceSpecification

IDeviceSpecification createDeviceSpecification(IDeviceSpecificationCreateRequest request)
                                        throws SiteWhereException

Create a new device specification.

Parameters:

request - information about new specification

Returns:

device specification that was created

Throws:

SiteWhereException

getDeviceSpecificationByToken

IDeviceSpecification getDeviceSpecificationByToken(java.lang.String token)
                                            throws SiteWhereException

Get a device specification by unique token.

Parameters:

token - unique device specification token

Returns:

corresponding specification or null if not found

Throws:

SiteWhereException - if implementation encountered an error

updateDeviceSpecification

IDeviceSpecification updateDeviceSpecification(java.lang.String token,
                                               IDeviceSpecificationCreateRequest request)
                                        throws SiteWhereException

Update an existing device specification.

Parameters:

token - unique specification token

request - updated information

Returns:

updated device specification

Throws:

SiteWhereException - if implementation encountered an error

listDeviceSpecifications

ISearchResults<IDeviceSpecification> listDeviceSpecifications(boolean includeDeleted,
                                                              ISearchCriteria criteria)
                                                       throws SiteWhereException

List device specifications that match the search criteria.

Parameters:

includeDeleted - include specifications marked as deleted

criteria - search criteria

Returns:

results corresponding to search criteria

Throws:

SiteWhereException - if implementation encountered an error

deleteDeviceSpecification

IDeviceSpecification deleteDeviceSpecification(java.lang.String token,
                                               boolean force)
                                        throws SiteWhereException

Delete an existing device specification.

Parameters:

token - unique specification token

force - if true, deletes specification. if false, marks as deleted.

Returns:

the deleted specification

Throws:

SiteWhereException - if implementation encountered an error

createDeviceCommand

IDeviceCommand createDeviceCommand(IDeviceSpecification spec,
                                   IDeviceCommandCreateRequest request)
                            throws SiteWhereException

Creates a device command associated with an existing device specification.

Parameters:

spec -

request -

Returns:

Throws:

SiteWhereException

getDeviceCommandByToken

IDeviceCommand getDeviceCommandByToken(java.lang.String token)
                                throws SiteWhereException

Get a device command by unique token.

Parameters:

token -

Returns:

Throws:

SiteWhereException

updateDeviceCommand

IDeviceCommand updateDeviceCommand(java.lang.String token,
                                   IDeviceCommandCreateRequest request)
                            throws SiteWhereException

Update an existing device command.

Parameters:

token -

request -

Returns:

Throws:

SiteWhereException

listDeviceCommands

java.util.List<IDeviceCommand> listDeviceCommands(java.lang.String specToken,
                                                  boolean includeDeleted)
                                           throws SiteWhereException

List device command objects associated with a device specification.

Parameters:

specToken -

includeDeleted -

Returns:

Throws:

SiteWhereException

deleteDeviceCommand

IDeviceCommand deleteDeviceCommand(java.lang.String token,
                                   boolean force)
                            throws SiteWhereException

Delete an existing device command.

Parameters:

token -

force -

Returns:

Throws:

SiteWhereException

createDevice

IDevice createDevice(IDeviceCreateRequest device)
              throws SiteWhereException

Create a new device.

Parameters:

device -

Returns:

Throws:

SiteWhereException

getDeviceByHardwareId

IDevice getDeviceByHardwareId(java.lang.String hardwareId)
                       throws SiteWhereException

Gets a device by unique hardware id.

Parameters:

hardwareId -

Returns:

Throws:

SiteWhereException

updateDevice

IDevice updateDevice(java.lang.String hardwareId,
                     IDeviceCreateRequest request)
              throws SiteWhereException

Update device information.

Parameters:

hardwareId -

request -

Returns:

Throws:

SiteWhereException

getCurrentDeviceAssignment

IDeviceAssignment getCurrentDeviceAssignment(IDevice device)
                                      throws SiteWhereException

Gets the current assignment for a device. Null if none.

Parameters:

device -

Returns:

Throws:

SiteWhereException

listDevices

ISearchResults<IDevice> listDevices(boolean includeDeleted,
                                    IDeviceSearchCriteria criteria)
                             throws SiteWhereException

List devices that meet the given criteria.

Parameters:

includeDeleted -

criteria -

Returns:

Throws:

SiteWhereException

createDeviceElementMapping

IDevice createDeviceElementMapping(java.lang.String hardwareId,
                                   IDeviceElementMapping mapping)
                            throws SiteWhereException

Create an IDeviceElementMapping for a nested device.

Parameters:

hardwareId -

mapping -

Returns:

Throws:

SiteWhereException

deleteDeviceElementMapping

IDevice deleteDeviceElementMapping(java.lang.String hardwareId,
                                   java.lang.String path)
                            throws SiteWhereException

Delete an exising IDeviceElementMapping from a device.

Parameters:

hardwareId -

path -

Returns:

Throws:

SiteWhereException

deleteDevice

IDevice deleteDevice(java.lang.String hardwareId,
                     boolean force)
              throws SiteWhereException

Delete an existing device.

Parameters:

hardwareId -

force -

Returns:

Throws:

SiteWhereException

createDeviceAssignment

IDeviceAssignment createDeviceAssignment(IDeviceAssignmentCreateRequest request)
                                  throws SiteWhereException

Create a new device assignment.

Parameters:

request -

Returns:

Throws:

SiteWhereException

getDeviceAssignmentByToken

IDeviceAssignment getDeviceAssignmentByToken(java.lang.String token)
                                      throws SiteWhereException

Get a device assignment by unique token.

Parameters:

token -

Returns:

Throws:

SiteWhereException

deleteDeviceAssignment

IDeviceAssignment deleteDeviceAssignment(java.lang.String token,
                                         boolean force)
                                  throws SiteWhereException

Delete a device assignment. Depending on 'force' flag the assignment will be marked for delete or actually be deleted.

Parameters:

token -

force -

Returns:

Throws:

SiteWhereException

getDeviceForAssignment

IDevice getDeviceForAssignment(IDeviceAssignment assignment)
                        throws SiteWhereException

Get the device associated with an assignment.

Parameters:

assignment -

Returns:

Throws:

SiteWhereException

getSiteForAssignment

ISite getSiteForAssignment(IDeviceAssignment assignment)
                    throws SiteWhereException

Get the site associated with an assignment.

Parameters:

assignment -

Returns:

Throws:

SiteWhereException

updateDeviceAssignmentMetadata

IDeviceAssignment updateDeviceAssignmentMetadata(java.lang.String token,
                                                 IMetadataProvider metadata)
                                          throws SiteWhereException

Update metadata associated with a device assignment.

Parameters:

token -

metadata -

Returns:

Throws:

SiteWhereException

updateDeviceAssignmentStatus

IDeviceAssignment updateDeviceAssignmentStatus(java.lang.String token,
                                               DeviceAssignmentStatus status)
                                        throws SiteWhereException

Update the status of an existing device assignment.

Parameters:

token -

status -

Returns:

Throws:

SiteWhereException

updateDeviceAssignmentState

IDeviceAssignment updateDeviceAssignmentState(java.lang.String token,
                                              IDeviceAssignmentState state)
                                       throws SiteWhereException

Updates the current state of a device assignment.

Parameters:

token -

state -

Returns:

Throws:

SiteWhereException

endDeviceAssignment

IDeviceAssignment endDeviceAssignment(java.lang.String token)
                               throws SiteWhereException

Ends a device assignment.

Parameters:

token -

Returns:

Throws:

SiteWhereException

getDeviceAssignmentHistory

ISearchResults<IDeviceAssignment> getDeviceAssignmentHistory(java.lang.String hardwareId,
                                                             ISearchCriteria criteria)
                                                      throws SiteWhereException

Get the device assignment history for a given device.

Parameters:

hardwareId -

criteria -

Returns:

Throws:

SiteWhereException

getDeviceAssignmentsForSite

ISearchResults<IDeviceAssignment> getDeviceAssignmentsForSite(java.lang.String siteToken,
                                                              IAssignmentSearchCriteria criteria)
                                                       throws SiteWhereException

Get a list of device assignments for a site.

Parameters:

siteToken -

criteria -

Returns:

Throws:

SiteWhereException

getDeviceAssignmentsWithLastInteraction

ISearchResults<IDeviceAssignment> getDeviceAssignmentsWithLastInteraction(java.lang.String siteToken,
                                                                          IDateRangeSearchCriteria criteria)
                                                                   throws SiteWhereException

Finds all device assignments for a site with a last interaction date in the given date range. Note that events must be posted with the 'updateState' option in order for the last interaction date to be updated.

Parameters:

siteToken -

criteria -

Returns:

Throws:

SiteWhereException

getMissingDeviceAssignments

ISearchResults<IDeviceAssignment> getMissingDeviceAssignments(java.lang.String siteToken,
                                                              ISearchCriteria criteria)
                                                       throws SiteWhereException

Find all device assignments that have been marked missing by the presence manager.

Parameters:

siteToken -

criteria -

Returns:

Throws:

SiteWhereException

getDeviceAssignmentsForAsset

ISearchResults<IDeviceAssignment> getDeviceAssignmentsForAsset(java.lang.String assetModuleId,
                                                               java.lang.String assetId,
                                                               IAssignmentsForAssetSearchCriteria criteria)
                                                        throws SiteWhereException

Get a list of device assignments associated with a given asset.

Parameters:

assetModuleId -

assetId -

criteria -

Returns:

Throws:

SiteWhereException

createDeviceStream

IDeviceStream createDeviceStream(java.lang.String assignmentToken,
                                 IDeviceStreamCreateRequest request)
                          throws SiteWhereException

Create a new IDeviceStream associated with an assignment.

Parameters:

assignmentToken -

request -

Returns:

Throws:

SiteWhereException

getDeviceStream

IDeviceStream getDeviceStream(java.lang.String assignmentToken,
                              java.lang.String streamId)
                       throws SiteWhereException

Get an exsiting IDeviceStream for an assignment based on unique stream id. Returns null if not found.

Parameters:

assignmentToken -

streamId -

Returns:

Throws:

SiteWhereException

listDeviceStreams

ISearchResults<IDeviceStream> listDeviceStreams(java.lang.String assignmentToken,
                                                ISearchCriteria criteria)
                                         throws SiteWhereException

List device streams for the assignment that meet the given criteria.

Parameters:

assignmentToken -

criteria -

Returns:

Throws:

SiteWhereException

createSite

ISite createSite(ISiteCreateRequest request)
          throws SiteWhereException

Create a site based on the given input.

Parameters:

request -

Returns:

Throws:

SiteWhereException

deleteSite

ISite deleteSite(java.lang.String siteToken,
                 boolean force)
          throws SiteWhereException

Delete a site based on unique site token. If 'force' is specified, the database object will be deleted, otherwise the deleted flag will be set to true.

Parameters:

siteToken -

force -

Returns:

Throws:

SiteWhereException

updateSite

ISite updateSite(java.lang.String siteToken,
                 ISiteCreateRequest request)
          throws SiteWhereException

Update information for a site.

Parameters:

siteToken -

request -

Returns:

Throws:

SiteWhereException

getSiteByToken

ISite getSiteByToken(java.lang.String token)
              throws SiteWhereException

Get a site by unique token.

Parameters:

token -

Returns:

Throws:

SiteWhereException

listSites

ISearchResults<ISite> listSites(ISearchCriteria criteria)
                         throws SiteWhereException

Get a list of all sites.

Parameters:

criteria -

Returns:

Throws:

SiteWhereException

createZone

IZone createZone(ISite site,
                 IZoneCreateRequest request)
          throws SiteWhereException

Create a new zone.

Parameters:

site -

request -

Returns:

Throws:

SiteWhereException

updateZone

IZone updateZone(java.lang.String token,
                 IZoneCreateRequest request)
          throws SiteWhereException

Update an existing zone.

Parameters:

token -

request -

Returns:

Throws:

SiteWhereException

getZone

IZone getZone(java.lang.String zoneToken)
       throws SiteWhereException

Get a zone by its unique token.

Parameters:

zoneToken -

Returns:

Throws:

SiteWhereException

listZones

ISearchResults<IZone> listZones(java.lang.String siteToken,
                                ISearchCriteria criteria)
                         throws SiteWhereException

Get a list of all zones associated with a Site.

Parameters:

siteToken -

criteria -

Returns:

Throws:

SiteWhereException

deleteZone

IZone deleteZone(java.lang.String zoneToken,
                 boolean force)
          throws SiteWhereException

Delete a zone given its unique token.

Parameters:

zoneToken -

force -

Returns:

Throws:

SiteWhereException

createDeviceGroup

IDeviceGroup createDeviceGroup(IDeviceGroupCreateRequest request)
                        throws SiteWhereException

Create a new device group.

Parameters:

request -

Returns:

Throws:

SiteWhereException

updateDeviceGroup

IDeviceGroup updateDeviceGroup(java.lang.String token,
                               IDeviceGroupCreateRequest request)
                        throws SiteWhereException

Update an existing device group.

Parameters:

token -

request -

Returns:

Throws:

SiteWhereException

getDeviceGroup

IDeviceGroup getDeviceGroup(java.lang.String token)
                     throws SiteWhereException

Get a device network by unique token.

Parameters:

token -

Returns:

Throws:

SiteWhereException

listDeviceGroups

ISearchResults<IDeviceGroup> listDeviceGroups(boolean includeDeleted,
                                              ISearchCriteria criteria)
                                       throws SiteWhereException

List device groups.

Parameters:

includeDeleted -

criteria -

Returns:

Throws:

SiteWhereException

listDeviceGroupsWithRole

ISearchResults<IDeviceGroup> listDeviceGroupsWithRole(java.lang.String role,
                                                      boolean includeDeleted,
                                                      ISearchCriteria criteria)
                                               throws SiteWhereException

Lists all device groups that have the given role.

Parameters:

role -

includeDeleted -

criteria -

Returns:

Throws:

SiteWhereException

deleteDeviceGroup

IDeviceGroup deleteDeviceGroup(java.lang.String token,
                               boolean force)
                        throws SiteWhereException

Delete a device group.

Parameters:

token -

force -

Returns:

Throws:

SiteWhereException

addDeviceGroupElements

java.util.List<IDeviceGroupElement> addDeviceGroupElements(java.lang.String groupToken,
                                                           java.util.List<IDeviceGroupElementCreateRequest> elements,
                                                           boolean ignoreDuplicates)
                                                    throws SiteWhereException

Add elements to a device group.

Parameters:

groupToken -

elements -

ignoreDuplicates -

Returns:

Throws:

SiteWhereException

removeDeviceGroupElements

java.util.List<IDeviceGroupElement> removeDeviceGroupElements(java.lang.String groupToken,
                                                              java.util.List<IDeviceGroupElementCreateRequest> elements)
                                                       throws SiteWhereException

Remove selected elements from a device group.

Parameters:

groupToken -

elements -

Returns:

Throws:

SiteWhereException

listDeviceGroupElements

ISearchResults<IDeviceGroupElement> listDeviceGroupElements(java.lang.String groupToken,
                                                            ISearchCriteria criteria)
                                                     throws SiteWhereException

List device group elements that meet the given criteria.

Parameters:

groupToken -

criteria -

Returns:

Throws:

SiteWhereException

createBatchOperation

IBatchOperation createBatchOperation(IBatchOperationCreateRequest request)
                              throws SiteWhereException

Creates an IBatchOperation to perform an operation on multiple devices.

Parameters:

request -

Returns:

Throws:

SiteWhereException

updateBatchOperation

IBatchOperation updateBatchOperation(java.lang.String token,
                                     IBatchOperationUpdateRequest request)
                              throws SiteWhereException

Update an existing IBatchOperation.

Parameters:

token -

request -

Returns:

Throws:

SiteWhereException

getBatchOperation

IBatchOperation getBatchOperation(java.lang.String token)
                           throws SiteWhereException

Get an IBatchOperation by unique token.

Parameters:

token -

Returns:

Throws:

SiteWhereException

listBatchOperations

ISearchResults<IBatchOperation> listBatchOperations(boolean includeDeleted,
                                                    ISearchCriteria criteria)
                                             throws SiteWhereException

List batch operations based on the given criteria.

Parameters:

includeDeleted -

criteria -

Returns:

Throws:

SiteWhereException

deleteBatchOperation

IBatchOperation deleteBatchOperation(java.lang.String token,
                                     boolean force)
                              throws SiteWhereException

Deletes a batch operation and its elements.

Parameters:

token -

force -

Returns:

Throws:

SiteWhereException

listBatchElements

ISearchResults<IBatchElement> listBatchElements(java.lang.String batchToken,
                                                IBatchElementSearchCriteria criteria)
                                         throws SiteWhereException

Lists elements for an IBatchOperation that meet the given criteria.

Parameters:

batchToken -

criteria -

Returns:

Throws:

SiteWhereException

updateBatchElement

IBatchElement updateBatchElement(java.lang.String operationToken,
                                 long index,
                                 IBatchElementUpdateRequest request)
                          throws SiteWhereException

Updates an existing batch operation element.

Parameters:

operationToken -

index -

request -

Returns:

Throws:

SiteWhereException

createBatchCommandInvocation

IBatchOperation createBatchCommandInvocation(IBatchCommandInvocationRequest request)
                                      throws SiteWhereException

Creates an ISearchResults that will invoke a command on multiple devices.

Parameters:

request -

Returns:

Throws:

SiteWhereException