com.sitewhere.rest.model.device.event

Class DeviceCommandInvocation

java.lang.Object

com.sitewhere.rest.model.common.MetadataProvider

com.sitewhere.rest.model.device.event.DeviceEvent

com.sitewhere.rest.model.device.event.DeviceCommandInvocation

All Implemented Interfaces:

IMetadataProvider, IDeviceCommandInvocation, IDeviceEvent, java.io.Serializable, java.lang.Comparable<IDeviceEvent>

public class DeviceCommandInvocation
extends DeviceEvent
implements IDeviceCommandInvocation, java.io.Serializable

Implementation of IDeviceCommandInvocation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeviceCommandInvocation()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAsHtml()
DeviceCommand	getCommand()
java.lang.String	getCommandToken() Get the unique token of the command to be executed.
CommandInitiator	getInitiator() Get actor type that initiated the command.
java.lang.String	getInitiatorId() Get unique id of command initiated.
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 actor type that received command.
java.lang.String	getTargetId() Get unique id of command target.
void	setAsHtml(java.lang.String asHtml)
void	setCommand(DeviceCommand command)
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.DeviceEvent

compareTo, copy, getAssetId, getAssetModuleId, getAssignmentType, getDeviceAssignmentToken, getEventDate, getEventType, getId, getReceivedDate, getSiteToken, setAssetId, setAssetModuleId, setAssignmentType, setDeviceAssignmentToken, setEventDate, setEventType, setId, setReceivedDate, setSiteToken

Methods inherited from class com.sitewhere.rest.model.common.MetadataProvider

addOrReplaceMetadata, clearMetadata, copy, copy, getMetadata, getMetadata, removeMetadata, setMetadata

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.IDeviceEvent

getAssetId, getAssetModuleId, getAssignmentType, getDeviceAssignmentToken, getEventDate, getEventType, getId, getReceivedDate, getSiteToken

Methods inherited from interface com.sitewhere.spi.common.IMetadataProvider

addOrReplaceMetadata, clearMetadata, getMetadata, getMetadata, removeMetadata

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

DeviceCommandInvocation

public DeviceCommandInvocation()

Method Detail

getInitiator

public CommandInitiator getInitiator()

Description copied from interface: IDeviceCommandInvocation

Get actor type that initiated the command.

Specified by:

getInitiator in interface IDeviceCommandInvocation

Returns:

setInitiator

public void setInitiator(CommandInitiator initiator)

getInitiatorId

public java.lang.String getInitiatorId()

Description copied from interface: IDeviceCommandInvocation

Get unique id of command initiated.

Specified by:

getInitiatorId in interface IDeviceCommandInvocation

Returns:

setInitiatorId

public void setInitiatorId(java.lang.String initiatorId)

getTarget

public CommandTarget getTarget()

Description copied from interface: IDeviceCommandInvocation

Get actor type that received command.

Specified by:

getTarget in interface IDeviceCommandInvocation

Returns:

setTarget

public void setTarget(CommandTarget target)

getTargetId

public java.lang.String getTargetId()

Description copied from interface: IDeviceCommandInvocation

Get unique id of command target.

Specified by:

getTargetId in interface IDeviceCommandInvocation

Returns:

setTargetId

public void setTargetId(java.lang.String targetId)

getCommandToken

public java.lang.String getCommandToken()

Description copied from interface: IDeviceCommandInvocation

Get the unique token of the command to be executed.

Specified by:

getCommandToken in interface IDeviceCommandInvocation

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

Get the list of parameter names mapped to values.

Specified by:

getParameterValues in interface IDeviceCommandInvocation

Returns:

setParameterValues

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

getStatus

public CommandStatus getStatus()

Description copied from interface: IDeviceCommandInvocation

Get status of command.

Specified by:

getStatus in interface IDeviceCommandInvocation

Returns:

setStatus

public void setStatus(CommandStatus status)

getCommand

public DeviceCommand getCommand()

setCommand

public void setCommand(DeviceCommand command)

getAsHtml

public java.lang.String getAsHtml()

setAsHtml

public void setAsHtml(java.lang.String asHtml)