Interface ZCLAttributeDescription

All Superinterfaces:

ZCLAttributeInfo

public interface ZCLAttributeDescription
extends ZCLAttributeInfo

This interface represents a ZCLAttributeDescription.

Author:

$Id: b70e73af10cdda12966cd7ca7599788dd55fdd35 $

Field Summary

Fields inherited from interface ZCLAttributeInfo

ID

Method Summary

Modifier and Type	Method	Description
Object	getDefaultValue()	Returns the attribute default value.
String	getName()	Returns the attribute name.
String	getShortDescription()	Returns the attribute functional description.
boolean	isMandatory()	Checks if this attribute is mandatory.
boolean	isPartOfAScene()	Checks if this attribute is part of a scene.
boolean	isReadOnly()	Checks if this attribute is read-only.
boolean	isReportable()	Checks if this attribute is reportable.

Methods inherited from interface ZCLAttributeInfo

getDataType, getId, getManufacturerCode, isManufacturerSpecific

Method Details

getName

String getName()

Returns the attribute name.

Returns:

the attribute name.

getShortDescription

String getShortDescription()

Returns the attribute functional description.

Returns:

the attribute functional description.

getDefaultValue

Object getDefaultValue()

Returns the attribute default value.

Returns:

the attribute default value.

isMandatory

boolean isMandatory()

Checks if this attribute is mandatory.

Returns:

true, if and only if the attribute is mandatory.

isReportable

boolean isReportable()

Checks if this attribute is reportable.

Returns:

true if and only if the attribute support subscription.

isReadOnly

boolean isReadOnly()

Checks if this attribute is read-only.

Returns:

true if the attribute is read only, false otherwise (that is, if the attribute is read/write or optionally writable (R*W)).

isPartOfAScene

boolean isPartOfAScene()

Checks if this attribute is part of a scene.

Returns:

true if the attribute is part of a scene (cluster), false otherwise.