com.sitewhere.rest.model.device.command

Class CommandParameter

java.lang.Object

com.sitewhere.rest.model.device.command.CommandParameter

All Implemented Interfaces:

ICommandParameter, java.io.Serializable

public class CommandParameter
extends java.lang.Object
implements ICommandParameter, java.io.Serializable

Model object for a command parameter.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandParameter()
CommandParameter(java.lang.String name, ParameterType type, boolean required)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Get parameter name.
ParameterType	getType() Get parameter datatype.
boolean	isRequired() Indicates if parameter is required for command.
void	setName(java.lang.String name)
void	setRequired(boolean required)
void	setType(ParameterType type)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandParameter

public CommandParameter()

CommandParameter

public CommandParameter(java.lang.String name,
                        ParameterType type,
                        boolean required)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: ICommandParameter

Get parameter name.

Specified by:

getName in interface ICommandParameter

Returns:

setName

public void setName(java.lang.String name)

getType

public ParameterType getType()

Description copied from interface: ICommandParameter

Get parameter datatype.

Specified by:

getType in interface ICommandParameter

Returns:

setType

public void setType(ParameterType type)

isRequired

public boolean isRequired()

Description copied from interface: ICommandParameter

Indicates if parameter is required for command.

Specified by:

isRequired in interface ICommandParameter

Returns:

setRequired

public void setRequired(boolean required)