com.sitewhere.spi.device.request

Interface IBatchCommandInvocationRequest

All Known Implementing Classes:

BatchCommandInvocationRequest

public interface IBatchCommandInvocationRequest

Parameters for a batch operation that executes a command for all devices in the batch.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	META_INVOCATION_EVENT_ID Metadata property on batch element that holds invocation event id
static java.lang.String	PARAM_COMMAND_TOKEN Batch operation parameter name for command token

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommandToken() Get token for command to be executed.
java.util.List<java.lang.String>	getHardwareIds() Get the list of targeted device hardware ids.
java.util.Map<java.lang.String,java.lang.String>	getParameterValues() Get the list of parameter names mapped to values.
java.lang.String	getToken() Get unique token for batch request.

Field Detail

PARAM_COMMAND_TOKEN

static final java.lang.String PARAM_COMMAND_TOKEN

Batch operation parameter name for command token

See Also:

Constant Field Values

META_INVOCATION_EVENT_ID

static final java.lang.String META_INVOCATION_EVENT_ID

Metadata property on batch element that holds invocation event id

See Also:

Constant Field Values

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:

getHardwareIds

java.util.List<java.lang.String> getHardwareIds()

Get the list of targeted device hardware ids.

Returns: