ch.ecma.csta.binding
Class GetLampMode

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

All Implemented Interfaces:

java.io.Serializable

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

Gets the lamp mode status of a specified button on a device. The GetLampMode request has these parameters:

GetLampMode Request Parameters
device	Mandatory	Specifies the physical element of the device.
lamp	Optional	Specifies which lamp to query. If not provided, then information is obtained on all the lamps associated with the device. Lamp IDs are the same as the associated button IDs.
extensions	Not Used

Negative Acknowledgements:

• operation:invalidDeviceID - Sent if there is no station associated with the DeviceID
• stateIncompatibility:invalidDeviceState - Sent if he station is not available to use - not registered yet
• operation:invalidLampID - Sent if the lamp module is not in the acceptable range.
• operation:lampNotSupported - Sent if the lamp is not assigned.
• operation:serviceNotSupported - Sent if the requested service is not supported
• unspecified - Sent if the request or the DeviceID inside the request is null or an implementation specific error occurred.

The lamp mode, color and associated button are returned in the response. The GetLampModeResponse contains these parameters:

GetLampModeResponse Parameters
lampModeList	Always provided	Specifies information about the specified lamp or about all lamps associated with the device if no lamp was provided in the request. Each item in the list is of type LampModeItem. The contents of a LampModeItem are shown in another table below.
lamp	Not Used
extensions	Not Used

Each item in the lampModeList is of type LampModeItem. A LampModeItem contains these parameters:

LampModeItem Parameters
lamp	Always provided	Indicates the lampID of this lamp. LampID is a string.
lampMode	Always provided	A value from 0 - 100 specifying how the lamp is lit (flutter, off, steady, etc.).
lampBrightness	Not supported
lampColor	Always provided	A value from 0 - 100 specifying the color of the lamp. Currently, only information for green lamps is returned.
button	Always provided	Specifies a button that is associated with this lamp. If null, then a button is not associated with this lamp.

There are no events generated from this service.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

GetLampMode()

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 GetLampMode	unmarshalGetLampMode(java.io.Reader reader) Method unmarshalGetLampMode
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

GetLampMode

public GetLampMode()

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

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

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. Optional. If not provided, then information is obtained on all the lamps associated with the device.

Parameters:

lamp - the value of field 'lamp'.

unmarshalGetLampMode

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

Method unmarshalGetLampMode

Parameters:

reader -

Returns:

GetLampMode

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