4.1.0.610 20071213

ch.ecma.csta.binding
Class GetButtonInformation

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

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

Gets the button information for either a specified button or all buttons on a device. p /> The GetButtonInformation request has these parameters:

GetButtonInformation Request Parameters
device Mandatory Specifies the physical element of the device.
button Optional Specifies the address of the button to be queried on the device. Use the Button ID constant enumerations. If no button is specified, information is obtained for all buttons on the device.
extensions Not Used

Negative Acknowledgements:

The requested button information is returned in the GetButtonInformationResponse. Here are the parameters that are returned:

GetButtonInformationResponse Parameters
buttonList Always provided Specifies information about the specified button or about all buttons associated with the device if no button was provided in the request. Each list item is of type ButtonItem. The ButtonItem structure is described below.
extensions Not used

Each ButtonItem in the buttonList contains these parameters:

ButtonItem Parameters
button Mandatory Specifies the button identifier (also known as the button address) of the button described by this entry.
buttonLabel Not supported
buttonLabelSettable Not supported Always false since the Set Button Information service is not yet supported.
buttonFunction Always provided The function assigned to the button.
buttonAssociatedNumber Conditional If the button has an associated extension, then that that extension is the content of this DeviceID. Otherwise, it is null.
buttonAssociatedNumberSettable Not supported
buttonPressIndicator Not supported
lampList Always provided 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.

There are no events generated from this service.

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

Constructor Summary
GetButtonInformation()
           
 
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 getDevice()
          Returns the value of field 'device'.
 CSTACommonArguments getExtensions()
          Returns the value of field 'extensions'.
 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 setDevice(DeviceID device)
          Sets the value of field 'device'.
 void setExtensions(CSTACommonArguments extensions)
          Sets the value of field 'extensions'.
static GetButtonInformation unmarshalGetButtonInformation(java.io.Reader reader)
          Method unmarshalGetButtonInformation
 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

GetButtonInformation

public GetButtonInformation()
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 which button to query. If not provided, then information is obtained on all the buttons associated with the device. This field is optional.

Returns:
String

getDevice

public DeviceID getDevice()
Returns the value of field 'device'. The field 'device' has the following description: Specifies the device's physical element. Setting of this field is mandatory.

Returns:
DeviceID

getExtensions

public CSTACommonArguments getExtensions()
Returns the value of field 'extensions'.

Returns:
CSTACommonArguments

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 which button to query. If not provided, then information is obtained on all the buttons associated with the device. This field is optional.

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

setDevice

public void setDevice(DeviceID device)
Sets the value of field 'device'. The field 'device' has the following description: Specifies the device's physical element. Setting of this field is mandatory.

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

setExtensions

public void setExtensions(CSTACommonArguments extensions)
Sets the value of field 'extensions'.

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

unmarshalGetButtonInformation

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

Parameters:
reader -
Returns:
GetButtonInformation
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.