ch.ecma.csta.binding
Class GetLampInformation

java.lang.Object
  ch.ecma.csta.CastorObject
      ch.ecma.csta.binding.GetLampInformation

All Implemented Interfaces:

java.io.Serializable

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

This request is not supported.

Gets the lamp information for either a specified lamp or all lamps on a device. Information includes lamp label, associated button (if applicable), and lamp color.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

GetLampInformation()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
DeviceID	getDevice() Returns the value of field 'device'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getLamp() Returns the value of field 'lamp'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setDevice(DeviceID device) Sets the value of field 'device'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setLamp(java.lang.String lamp) Sets the value of field 'lamp'.
static GetLampInformation	unmarshalGetLampInformation(java.io.Reader reader) Method unmarshalGetLampInformation
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

GetLampInformation

public GetLampInformation()

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

getDevice

public DeviceID getDevice()

Returns the value of field 'device'. The field 'device' has the following description: Specifies the device's physical element.

Returns:

DeviceID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getLamp

public java.lang.String getLamp()

Returns the value of field 'lamp'. The field 'lamp' has the following description: Specifies which lamp to query. If not provided, then information is obtained on all the lamps associated with the device.

Returns:

String

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

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.

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'.

setLamp

public void setLamp(java.lang.String lamp)

Sets the value of field 'lamp'. The field 'lamp' has the following description: Specifies which lamp to query. If not provided, then information is obtained on all the lamps associated with the device.

Parameters:

lamp - the value of field 'lamp'.

unmarshalGetLampInformation

public static GetLampInformation unmarshalGetLampInformation(java.io.Reader reader)
                                                      throws org.exolab.castor.xml.MarshalException,
                                                             org.exolab.castor.xml.ValidationException

Method unmarshalGetLampInformation

Parameters:

reader -

Returns:

GetLampInformation

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