com.sitewhere.spi.device.request

Interface IBatchCommandForCriteriaRequest

All Known Implementing Classes:

BatchCommandForCriteriaRequest

public interface IBatchCommandForCriteriaRequest

Provides values needed for sending a IBatchCommandInvocationRequest based on devices that meet given criteria.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommandToken() Get token for command to be executed.
java.util.Date	getEndDate() Get date range end.
java.lang.String	getGroupsWithRole() If set, only devices in groups with the given role will be sent the command.
java.lang.String	getGroupToken() If set, only devices in the given group will be sent the command.
java.util.Map<java.lang.String,java.lang.String>	getParameterValues() Get the list of parameter names mapped to values.
java.lang.String	getSiteToken() If set, only devices associated with the given site will be sent the command.
java.lang.String	getSpecificationToken() If set, only devices with the given specification token will be sent the command.
java.util.Date	getStartDate() Get date range start.
java.lang.String	getToken() Get unique token for batch request.

Method Detail

getToken

java.lang.String getToken()

Get unique token for batch request.

Returns:

getCommandToken

java.lang.String getCommandToken()

Get token for command to be executed.

Returns:

getParameterValues

java.util.Map<java.lang.String,java.lang.String> getParameterValues()

Get the list of parameter names mapped to values.

Returns:

getSpecificationToken

java.lang.String getSpecificationToken()

If set, only devices with the given specification token will be sent the command.

Returns:

getGroupToken

java.lang.String getGroupToken()

If set, only devices in the given group will be sent the command.

Returns:

getGroupsWithRole

java.lang.String getGroupsWithRole()

If set, only devices in groups with the given role will be sent the command.

Returns:

getSiteToken

java.lang.String getSiteToken()

If set, only devices associated with the given site will be sent the command.

Returns:

getStartDate

java.util.Date getStartDate()

Get date range start.

Returns:

getEndDate

java.util.Date getEndDate()

Get date range end.

Returns: