Top Description Methods
org.osgi.service.zigbee.descriptions

public Interface ZCLCommandDescription


This interface represents a ZCLCommandDescription.
Author
$Id: af022a52a6f9c7ca8f60c96b619d49d1f85ed1ea $

Method Summary

Modifier and TypeMethod and Description
public short

Returns:

the command identifier.
getId
()

Returns the command identifier.

public int

Returns:

the manufacturer code.
getManufacturerCode
()

Returns the manufacturer code.

public String

Returns:

the command name.
getName
()

Returns the command name.

public ZCLParameterDescription[]

Returns:

an array of the parameter descriptions.
getParameterDescriptions
()

Returns an array of the parameter descriptions.

public String

Returns:

the command functional description.
getShortDescription
()

Returns the command functional description.

public boolean

Returns:

the isClientServerDirection value.
isClientServerDirection
()

Checks if this is a server-side command (that is going from the client to server direction).

public boolean

Returns:

the isClusterSpecificCommand value.
isClusterSpecificCommand
()

public boolean

Returns:

true, if and only if the command is mandatory.
isMandatory
()

Checks if this command it mandatory.

public boolean

Returns:

true if end only if getManufacturerCode() is not. -1.
isManufacturerSpecific
()

Checks if the command is manufacturer specific.

Method Detail

getIdback to summary
public short getId()

Returns the command identifier.

Returns:short

the command identifier.

getManufacturerCodeback to summary
public int getManufacturerCode()

Returns the manufacturer code. Default value is: -1 (no code).

Returns:int

the manufacturer code.

getNameback to summary
public String getName()

Returns the command name.

Returns:String

the command name.

getParameterDescriptionsback to summary
public ZCLParameterDescription[] getParameterDescriptions()

Returns an array of the parameter descriptions.

Returns:ZCLParameterDescription[]

an array of the parameter descriptions.

getShortDescriptionback to summary
public String getShortDescription()

Returns the command functional description.

Returns:String

the command functional description.

isClientServerDirectionback to summary
public boolean isClientServerDirection()

Checks if this is a server-side command (that is going from the client to server direction).

Returns:boolean

the isClientServerDirection value.

isClusterSpecificCommandback to summary
public boolean isClusterSpecificCommand()
Returns:boolean

the isClusterSpecificCommand value.

isMandatoryback to summary
public boolean isMandatory()

Checks if this command it mandatory.

Returns:boolean

true, if and only if the command is mandatory.

isManufacturerSpecificback to summary
public boolean isManufacturerSpecific()

Checks if the command is manufacturer specific.

Returns:boolean

true if end only if getManufacturerCode() is not. -1.