com.sitewhere.rest.model.device.request

Class BatchCommandInvocationRequest

java.lang.Object

com.sitewhere.rest.model.device.request.BatchCommandInvocationRequest

All Implemented Interfaces:

IBatchCommandInvocationRequest, java.io.Serializable

public class BatchCommandInvocationRequest
extends java.lang.Object
implements IBatchCommandInvocationRequest, java.io.Serializable

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

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.sitewhere.spi.device.request.IBatchCommandInvocationRequest

META_INVOCATION_EVENT_ID, PARAM_COMMAND_TOKEN

Constructor Summary

Constructors

Constructor and Description
BatchCommandInvocationRequest()

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.
void	setCommandToken(java.lang.String commandToken)
void	setHardwareIds(java.util.List<java.lang.String> hardwareIds)
void	setParameterValues(java.util.Map<java.lang.String,java.lang.String> parameterValues)
void	setToken(java.lang.String token)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BatchCommandInvocationRequest

public BatchCommandInvocationRequest()

Method Detail

getToken

public java.lang.String getToken()

Description copied from interface: IBatchCommandInvocationRequest

Get unique token for batch request.

Specified by:

getToken in interface IBatchCommandInvocationRequest

Returns:

setToken

public void setToken(java.lang.String token)

getCommandToken

public java.lang.String getCommandToken()

Description copied from interface: IBatchCommandInvocationRequest

Get token for command to be executed.

Specified by:

getCommandToken in interface IBatchCommandInvocationRequest

Returns:

setCommandToken

public void setCommandToken(java.lang.String commandToken)

getParameterValues

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

Description copied from interface: IBatchCommandInvocationRequest

Get the list of parameter names mapped to values.

Specified by:

getParameterValues in interface IBatchCommandInvocationRequest

Returns:

setParameterValues

public void setParameterValues(java.util.Map<java.lang.String,java.lang.String> parameterValues)

getHardwareIds

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

Description copied from interface: IBatchCommandInvocationRequest

Get the list of targeted device hardware ids.

Specified by:

getHardwareIds in interface IBatchCommandInvocationRequest

Returns:

setHardwareIds

public void setHardwareIds(java.util.List<java.lang.String> hardwareIds)