com.sitewhere.rest.model.device.event.request

Class DeviceCommandInvocationCreateRequest

java.lang.Object

com.sitewhere.rest.model.device.event.request.DeviceEventCreateRequest

com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest

All Implemented Interfaces:

IDeviceCommandInvocationCreateRequest, IDeviceEventCreateRequest, java.io.Serializable

public class DeviceCommandInvocationCreateRequest
extends DeviceEventCreateRequest
implements IDeviceCommandInvocationCreateRequest, java.io.Serializable

Model object used to create a new DeviceCommandInvocation via REST APIs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeviceCommandInvocationCreateRequest.Builder

Constructor Summary

Constructors

Constructor and Description
DeviceCommandInvocationCreateRequest()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommandToken() Get unique token for command to invoke.
CommandInitiator	getInitiator() Get command initiator type.
java.lang.String	getInitiatorId() Get unique id of command inititator.
java.util.Map<java.lang.String,java.lang.String>	getParameterValues() Get the list of parameter names mapped to values.
CommandStatus	getStatus() Get status of command.
CommandTarget	getTarget() Get command target type.
java.lang.String	getTargetId() Get unique id of command target.
void	setCommandToken(java.lang.String commandToken)
void	setInitiator(CommandInitiator initiator)
void	setInitiatorId(java.lang.String initiatorId)
void	setParameterValues(java.util.Map<java.lang.String,java.lang.String> parameterValues)
void	setStatus(CommandStatus status)
void	setTarget(CommandTarget target)
void	setTargetId(java.lang.String targetId)

Methods inherited from class com.sitewhere.rest.model.device.event.request.DeviceEventCreateRequest

getEventDate, getMetadata, isUpdateState, setEventDate, setMetadata, setUpdateState

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sitewhere.spi.device.event.request.IDeviceEventCreateRequest

getEventDate, getMetadata, isUpdateState, setUpdateState

Constructor Detail

DeviceCommandInvocationCreateRequest

public DeviceCommandInvocationCreateRequest()

Method Detail

getInitiator

public CommandInitiator getInitiator()

Description copied from interface: IDeviceCommandInvocationCreateRequest

Get command initiator type.

Specified by:

getInitiator in interface IDeviceCommandInvocationCreateRequest

Returns:

setInitiator

public void setInitiator(CommandInitiator initiator)

getInitiatorId

public java.lang.String getInitiatorId()

Description copied from interface: IDeviceCommandInvocationCreateRequest

Get unique id of command inititator.

Specified by:

getInitiatorId in interface IDeviceCommandInvocationCreateRequest

Returns:

setInitiatorId

public void setInitiatorId(java.lang.String initiatorId)

getTarget

public CommandTarget getTarget()

Description copied from interface: IDeviceCommandInvocationCreateRequest

Get command target type.

Specified by:

getTarget in interface IDeviceCommandInvocationCreateRequest

Returns:

setTarget

public void setTarget(CommandTarget target)

getTargetId

public java.lang.String getTargetId()

Description copied from interface: IDeviceCommandInvocationCreateRequest

Get unique id of command target.

Specified by:

getTargetId in interface IDeviceCommandInvocationCreateRequest

Returns:

setTargetId

public void setTargetId(java.lang.String targetId)

getCommandToken

public java.lang.String getCommandToken()

Description copied from interface: IDeviceCommandInvocationCreateRequest

Get unique token for command to invoke.

Specified by:

getCommandToken in interface IDeviceCommandInvocationCreateRequest

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: IDeviceCommandInvocationCreateRequest

Get the list of parameter names mapped to values.

Specified by:

getParameterValues in interface IDeviceCommandInvocationCreateRequest

Returns:

setParameterValues

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

getStatus

public CommandStatus getStatus()

Description copied from interface: IDeviceCommandInvocationCreateRequest

Get status of command.

Specified by:

getStatus in interface IDeviceCommandInvocationCreateRequest

Returns:

setStatus

public void setStatus(CommandStatus status)