4.1.0.610 20071213

ch.ecma.csta.binding
Class ButtonItem

java.lang.Object
  extended by ch.ecma.csta.CastorObject
      extended by ch.ecma.csta.binding.ButtonItem
All Implemented Interfaces:
java.io.Serializable

public class ButtonItem
extends ch.ecma.csta.CastorObject
implements java.io.Serializable

Contains information about a button.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
ButtonItem()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
          Note: hashCode() has not been overriden
 java.lang.String getButton()
          Returns the value of field 'button'.
 DeviceID getButtonAssociatedNumber()
          Returns the value of field 'buttonAssociatedNumber'.
 java.lang.Boolean getButtonAssociatedNumberSettable()
          Returns the value of field 'buttonAssociatedNumberSettable'.
 java.lang.String getButtonFunction()
          Returns the value of field 'buttonFunction'.
 java.lang.String getButtonLabel()
          Returns the value of field 'buttonLabel'.
 java.lang.Boolean getButtonLabelSettable()
          Returns the value of field 'buttonLabelSettable'.
 java.lang.Boolean getButtonPressIndicator()
          Returns the value of field 'buttonPressIndicator'.
 LampIDList getLampList()
          Returns the value of field 'lampList'.
 boolean isValid()
          Method isValid
 void marshal(org.xml.sax.ContentHandler handler)
          Method marshal
 void marshal(java.io.Writer out)
          Method marshal
 void setButton(java.lang.String button)
          Sets the value of field 'button'.
 void setButtonAssociatedNumber(DeviceID buttonAssociatedNumber)
          Sets the value of field 'buttonAssociatedNumber'.
 void setButtonAssociatedNumberSettable(java.lang.Boolean buttonAssociatedNumberSettable)
          Sets the value of field 'buttonAssociatedNumberSettable'.
 void setButtonFunction(java.lang.String buttonFunction)
          Sets the value of field 'buttonFunction'.
 void setButtonLabel(java.lang.String buttonLabel)
          Sets the value of field 'buttonLabel'.
 void setButtonLabelSettable(java.lang.Boolean buttonLabelSettable)
          Sets the value of field 'buttonLabelSettable'.
 void setButtonPressIndicator(java.lang.Boolean buttonPressIndicator)
          Sets the value of field 'buttonPressIndicator'.
 void setLampList(LampIDList lampList)
          Sets the value of field 'lampList'.
static ButtonItem unmarshalButtonItem(java.io.Reader reader)
          Method unmarshalButtonItem
 void validate()
          Method validate
 
Methods inherited from class ch.ecma.csta.CastorObject
getOldSessionID, hashCode, setOldSessionID, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ButtonItem

public ButtonItem()
Method Detail

equals

public boolean equals(java.lang.Object obj)
Note: hashCode() has not been overriden

Overrides:
equals in class ch.ecma.csta.CastorObject
Parameters:
obj -
Returns:
boolean

getButton

public java.lang.String getButton()
Returns the value of field 'button'. The field 'button' has the following description: Specifies the button identifier (also known as the button address) of the button described by this entry. Mandatory.

Returns:
String

getButtonAssociatedNumber

public DeviceID getButtonAssociatedNumber()
Returns the value of field 'buttonAssociatedNumber'. The field 'buttonAssociatedNumber' has the following description: Conditional. If the button has an associated extension, then that that extension is the content of this DeviceID. Otherwise, it is null.

Returns:
DeviceID

getButtonAssociatedNumberSettable

public java.lang.Boolean getButtonAssociatedNumberSettable()
Returns the value of field 'buttonAssociatedNumberSettable'. The field 'buttonAssociatedNumberSettable' has the following description: Not supported.

Returns:
Boolean

getButtonFunction

public java.lang.String getButtonFunction()
Returns the value of field 'buttonFunction'. The field 'buttonFunction' has the following description: The function assigned to the button. Always provided.

Returns:
String

getButtonLabel

public java.lang.String getButtonLabel()
Returns the value of field 'buttonLabel'. The field 'buttonLabel' has the following description: Not supported.

Returns:
String

getButtonLabelSettable

public java.lang.Boolean getButtonLabelSettable()
Returns the value of field 'buttonLabelSettable'. The field 'buttonLabelSettable' has the following description: Not supported. Always false since the Set Button Information service is not yet supported.

Returns:
Boolean

getButtonPressIndicator

public java.lang.Boolean getButtonPressIndicator()
Returns the value of field 'buttonPressIndicator'. The field 'buttonPressIndicator' has the following description: Not supported.

Returns:
Boolean

getLampList

public LampIDList getLampList()
Returns the value of field 'lampList'. The field 'lampList' has the following description: List of LampIDs - These are the lamps that are associated with the button. There is always only one lampID and it is the same as the buttonID. The lamp is the green lamp. Red lamps are ignored. Always provided.

Returns:
LampIDList

isValid

public boolean isValid()
Method isValid

Returns:
boolean

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Method marshal

Parameters:
out -
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Method marshal

Parameters:
handler -
Throws:
java.io.IOException
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

setButton

public void setButton(java.lang.String button)
Sets the value of field 'button'. The field 'button' has the following description: Specifies the button identifier (also known as the button address) of the button described by this entry. Mandatory.

Parameters:
button - the value of field 'button'.

setButtonAssociatedNumber

public void setButtonAssociatedNumber(DeviceID buttonAssociatedNumber)
Sets the value of field 'buttonAssociatedNumber'. The field 'buttonAssociatedNumber' has the following description: Conditional. If the button has an associated extension, then that that extension is the content of this DeviceID. Otherwise, it is null.

Parameters:
buttonAssociatedNumber - the value of field 'buttonAssociatedNumber'.

setButtonAssociatedNumberSettable

public void setButtonAssociatedNumberSettable(java.lang.Boolean buttonAssociatedNumberSettable)
Sets the value of field 'buttonAssociatedNumberSettable'. The field 'buttonAssociatedNumberSettable' has the following description: Not supported.

Parameters:
buttonAssociatedNumberSettable - the value of field 'buttonAssociatedNumberSettable'.

setButtonFunction

public void setButtonFunction(java.lang.String buttonFunction)
Sets the value of field 'buttonFunction'. The field 'buttonFunction' has the following description: The function assigned to the button. Always provided.

Parameters:
buttonFunction - the value of field 'buttonFunction'.

setButtonLabel

public void setButtonLabel(java.lang.String buttonLabel)
Sets the value of field 'buttonLabel'. The field 'buttonLabel' has the following description: Not supported.

Parameters:
buttonLabel - the value of field 'buttonLabel'.

setButtonLabelSettable

public void setButtonLabelSettable(java.lang.Boolean buttonLabelSettable)
Sets the value of field 'buttonLabelSettable'. The field 'buttonLabelSettable' has the following description: Not supported. Always false since the Set Button Information service is not yet supported.

Parameters:
buttonLabelSettable - the value of field 'buttonLabelSettable'.

setButtonPressIndicator

public void setButtonPressIndicator(java.lang.Boolean buttonPressIndicator)
Sets the value of field 'buttonPressIndicator'. The field 'buttonPressIndicator' has the following description: Not supported.

Parameters:
buttonPressIndicator - the value of field 'buttonPressIndicator'.

setLampList

public void setLampList(LampIDList lampList)
Sets the value of field 'lampList'. The field 'lampList' has the following description: List of LampIDs - These are the lamps that are associated with the button. There is always only one lampID and it is the same as the buttonID. The lamp is the green lamp. Red lamps are ignored. Always provided.

Parameters:
lampList - the value of field 'lampList'.

unmarshalButtonItem

public static ButtonItem unmarshalButtonItem(java.io.Reader reader)
                                      throws org.exolab.castor.xml.MarshalException,
                                             org.exolab.castor.xml.ValidationException
Method unmarshalButtonItem

Parameters:
reader -
Returns:
ButtonItem
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Method validate

Throws:
org.exolab.castor.xml.ValidationException

4.1.0.610 20071213

Copyright 2004 Avaya Inc All Rights Reserved.