|
4.1.0.610 20071213 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectch.ecma.csta.CastorObject
ch.ecma.csta.binding.GetButtonInformation
public class GetButtonInformation
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 |
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 |
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. |
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 |
---|
public GetButtonInformation()
Method Detail |
---|
public boolean equals(java.lang.Object obj)
equals
in class ch.ecma.csta.CastorObject
obj
-
public java.lang.String getButton()
public DeviceID getDevice()
public CSTACommonArguments getExtensions()
public boolean isValid()
public void marshal(java.io.Writer out) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
out
-
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException
public void marshal(org.xml.sax.ContentHandler handler) throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
handler
-
java.io.IOException
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException
public void setButton(java.lang.String button)
button
- the value of field 'button'.public void setDevice(DeviceID device)
device
- the value of field 'device'.public void setExtensions(CSTACommonArguments extensions)
extensions
- the value of field 'extensions'.public static GetButtonInformation unmarshalGetButtonInformation(java.io.Reader reader) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
reader
-
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException
public void validate() throws org.exolab.castor.xml.ValidationException
org.exolab.castor.xml.ValidationException
|
4.1.0.610 20071213 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |