com.sitewhere.rest.model.device.command

Class DeviceCommand

java.lang.Object

com.sitewhere.rest.model.common.MetadataProvider

com.sitewhere.rest.model.common.MetadataProviderEntity

com.sitewhere.rest.model.device.command.DeviceCommand

All Implemented Interfaces:

IMetadataProvider, IMetadataProviderEntity, ISiteWhereEntity, IDeviceCommand, java.io.Serializable

public class DeviceCommand
extends MetadataProviderEntity
implements IDeviceCommand, java.io.Serializable

Model object for a command that can be invoked on a device.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeviceCommand()

Method Summary

Modifier and Type	Method and Description
static DeviceCommand	copy(IDeviceCommand input) Create a copy of an SPI object.
java.lang.String	getDescription() Get a description of the command.
java.lang.String	getName() Get command name.
java.lang.String	getNamespace() Optional namespace for distinguishing commands.
java.util.List<ICommandParameter>	getParameters() Get list of parameters.
java.lang.String	getSpecificationToken() Get token for the parent specification.
java.lang.String	getToken() Get the unique command token.
void	setDescription(java.lang.String description)
void	setName(java.lang.String name)
void	setNamespace(java.lang.String namespace)
void	setParameters(java.util.List<CommandParameter> parameters)
void	setSpecificationToken(java.lang.String specificationToken)
void	setToken(java.lang.String token)

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

copy, getCreatedBy, getCreatedDate, getUpdatedBy, getUpdatedDate, isDeleted, setCreatedBy, setCreatedDate, setDeleted, setUpdatedBy, setUpdatedDate

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.common.IMetadataProvider

addOrReplaceMetadata, clearMetadata, getMetadata, getMetadata, removeMetadata

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

getCreatedBy, getCreatedDate, getUpdatedBy, getUpdatedDate, isDeleted

Constructor Detail

DeviceCommand

public DeviceCommand()

Method Detail

getToken

public java.lang.String getToken()

Description copied from interface: IDeviceCommand

Get the unique command token.

Specified by:

getToken in interface IDeviceCommand

Returns:

setToken

public void setToken(java.lang.String token)

getSpecificationToken

public java.lang.String getSpecificationToken()

Description copied from interface: IDeviceCommand

Get token for the parent specification.

Specified by:

getSpecificationToken in interface IDeviceCommand

Returns:

setSpecificationToken

public void setSpecificationToken(java.lang.String specificationToken)

getNamespace

public java.lang.String getNamespace()

Description copied from interface: IDeviceCommand

Optional namespace for distinguishing commands.

Specified by:

getNamespace in interface IDeviceCommand

Returns:

setNamespace

public void setNamespace(java.lang.String namespace)

getName

public java.lang.String getName()

Description copied from interface: IDeviceCommand

Get command name.

Specified by:

getName in interface IDeviceCommand

Returns:

setName

public void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

Description copied from interface: IDeviceCommand

Get a description of the command.

Specified by:

getDescription in interface IDeviceCommand

Returns:

setDescription

public void setDescription(java.lang.String description)

getParameters

public java.util.List<ICommandParameter> getParameters()

Description copied from interface: IDeviceCommand

Get list of parameters.

Specified by:

getParameters in interface IDeviceCommand

Returns:

setParameters

public void setParameters(java.util.List<CommandParameter> parameters)

copy

public static DeviceCommand copy(IDeviceCommand input)
                          throws SiteWhereException

Create a copy of an SPI object. Used by web services for marshaling.

Parameters:

input -

Returns:

Throws:

SiteWhereException