de.siemens.icn.hipath.dls.apiv100.device
Class Attribute
java.lang.Object
de.siemens.icn.hipath.dls.apiv100.device.Attribute
- All Implemented Interfaces:
- java.lang.Comparable
public class Attribute
- extends java.lang.Object
- implements java.lang.Comparable
This class represents an attribute value which may be send to DLS API in order to configure
devices. An attribute is always embedded into other types (e.g. Device) which are accepted as configuration types
by DLS API methods.
An attribute name always equals an XML item name used by DLS to communicate with devices. Therefore,
the attribute name must not be empty when submitting the attribute to DLS.
Each attribute is validated when sent to DLS. Whether an attribute is valid or not depends
on its current context. E.g. when an attribute is required in a certain context, then it is 'OK'
if its value is not null and not empty. But the same attribute (i.e. an attribute with the same name)
may be not mandatory in another context, and therefore maybe 'OK' although is is null or empty. Check
the validation state of an attribute to see whether the attribute was 'OK' or not when sent to DLS.
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Attribute
public Attribute()
getName
public java.lang.String getName()
- Returns:
- The attribute name.
setName
public void setName(java.lang.String name)
getValue
public java.lang.String getValue()
- Returns:
- The attribute value.
setValue
public void setValue(java.lang.String value)
getValidationState
public java.lang.String getValidationState()
- Returns:
- The attribute validation state. The validation state is 'OK' when the attribute was validated
positively, or it describes the validation failure, when validated negatively.
toString
public java.lang.String toString()
- Overrides:
toString
in class java.lang.Object
compareTo
public int compareTo(java.lang.Object object)
- Specified by:
compareTo
in interface java.lang.Comparable