com.sitewhere.spi.device.event

Interface IDeviceCommandInvocation

All Superinterfaces:

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

All Known Implementing Classes:

DeviceCommandInvocation, DeviceCommandInvocationWithAsset

public interface IDeviceCommandInvocation
extends IDeviceEvent

Captures information about the invocation of a command.

Method Summary

Modifier and Type	Method and Description
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.

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

Method Detail

getInitiator

CommandInitiator getInitiator()

Get actor type that initiated the command.

Returns:

getInitiatorId

java.lang.String getInitiatorId()

Get unique id of command initiated.

Returns:

getTarget

CommandTarget getTarget()

Get actor type that received command.

Returns:

getTargetId

java.lang.String getTargetId()

Get unique id of command target.

Returns:

getCommandToken

java.lang.String getCommandToken()

Get the unique token of the 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:

getStatus

CommandStatus getStatus()

Get status of command.

Returns: