de.siemens.icn.hipath.dls.apiv100.device
Class AttributeDescription

java.lang.Object
  extended by de.siemens.icn.hipath.dls.apiv100.device.AttributeDescription

public class AttributeDescription
extends java.lang.Object

Describes configuration attributes suitable for configuring devices via dlsapi interface.


Constructor Summary
AttributeDescription()
           
AttributeDescription(java.lang.String name, java.lang.String type, java.lang.String[] valueList, boolean isRequired)
           
 
Method Summary
 java.lang.String getName()
           
 java.lang.String getType()
           
 java.lang.String[] getValueList()
           
 boolean isRequired()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AttributeDescription

public AttributeDescription()

AttributeDescription

public AttributeDescription(java.lang.String name,
                            java.lang.String type,
                            java.lang.String[] valueList,
                            boolean isRequired)
Method Detail

getName

public java.lang.String getName()
Returns:
The attributes name. The attributes describes an XML item.

getType

public java.lang.String getType()
Returns:
The type is an XML item type which correspands to a simple WSDL type. Following types are supported:
XML item types:
type description WSDL type
char<xxx> a string with a maximum of <xxx> characters xsd:string
int<xxx> an integer with a maximum of <xxx> digits xsd:boolean
enum<xxx> an enumerartion of strings as described in enum overview xsd:string

getValueList

public java.lang.String[] getValueList()
Returns:
If type is an enum type then the value list represents the enum values. Otherwise value list is an array of length '0'.

isRequired

public boolean isRequired()
Returns:
If the attribute required an if type is
  • is_String or is_Password: The value must be a non-empty string.
  • is_Coded: The value must be one of the values gven by getValueList()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object