ch.ecma.csta.binding
Class LampModeEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Indicates that the lamp mode status of a particular lamp has changed. This event may be generated in any one of the following ways:

• A feature associated with the lamp has changed status because of a manual button depression.
• A computing function, on behalf of a user, has sent the SetLampMode request.

At least one of the following parameters will be provided: lamp label, lamp brightness, lamp color.

The parameters of the LampUpdatedEvent structure are:

LampUpdatedEvent Parameters
monitorCrossRefID	Not used	Ignore. Currently only used internally.
device	Always provided	Specifies the lamp identifier of the lamp on the device. Type is SubjectDeviceID.
lamp	Always provided	Indicates the lampID of this lamp. LampID is a string. If the lamp has an associated button, the lamp ID and the button ID are the same.
lampLabel	Not supported
lampMode	Always provided	A value from 0 - 100 specifying how the lamp is lit (flutter, off, steady, etc.).
lampBrightness	Not supported	Always set to unspecified.
lampColor	Always provided	A value from 0 - 100 specifying the color of the lamp.
extensions	Not supported

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

LampModeEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
SubjectDeviceID	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'.
LampBrightness	getLampBrightness() Returns the value of field 'lampBrightness'.
java.lang.Short	getLampColor() Returns the value of field 'lampColor'.
java.lang.String	getLampLabel() Returns the value of field 'lampLabel'.
java.lang.Short	getLampMode() Returns the value of field 'lampMode'.
java.lang.String	getMonitorCrossRefID() Returns the value of field 'monitorCrossRefID'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setDevice(SubjectDeviceID 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'.
void	setLampBrightness(LampBrightness lampBrightness) Sets the value of field 'lampBrightness'.
void	setLampColor(java.lang.Short lampColor) Sets the value of field 'lampColor'.
void	setLampLabel(java.lang.String lampLabel) Sets the value of field 'lampLabel'.
void	setLampMode(java.lang.Short lampMode) Sets the value of field 'lampMode'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
static LampModeEvent	unmarshalLampModeEvent(java.io.Reader reader) Method unmarshalLampModeEvent
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

LampModeEvent

public LampModeEvent()

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 SubjectDeviceID getDevice()

Returns the value of field 'device'. The field 'device' has the following description: Specifies the device where the lamp mode status was changed. Mandatory.

Returns:

SubjectDeviceID

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 the lamp identifier of the lamp on the device. Lamp identifier is a string. If the lamp has an associated button, the lamp ID and the button ID are the same. Mandatory.

Returns:

String

getLampBrightness

public LampBrightness getLampBrightness()

Returns the value of field 'lampBrightness'. The field 'lampBrightness' has the following description: Indicates the intensity of the lamp if it is on (as indicated by lampMode parameter). Actual visible brightness levels are lamp-dependent. Optional.

The complete set of possible values is:

• Unspecified/Normal (default)
• Dim
• Bright

Returns:

LampBrightness

getLampColor

public java.lang.Short getLampColor()

Returns the value of field 'lampColor'. The field 'lampColor' has the following description: A value from 0 - 100 specifying the color of the lamp. Mandatory.

Returns:

Short

getLampLabel

public java.lang.String getLampLabel()

Returns the value of field 'lampLabel'. The field 'lampLabel' has the following description: Specifies the label by which the lamp may be referenced. Not supported.

Returns:

String

getLampMode

public java.lang.Short getLampMode()

Returns the value of field 'lampMode'. The field 'lampMode' has the following description: Specifies how the lamp is lit. Mandatory.

A value from 0 - 100 specifying how the lamp is lit (flutter, off, steady, etc.)

Returns:

Short

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()

Returns the value of field 'monitorCrossRefID'.

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(SubjectDeviceID device)

Sets the value of field 'device'. The field 'device' has the following description: Specifies the device where the lamp mode status was changed. 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 the lamp identifier of the lamp on the device. Lamp identifier is a string. If the lamp has an associated button, the lamp ID and the button ID are the same. Mandatory.

Parameters:

lamp - the value of field 'lamp'.

setLampBrightness

public void setLampBrightness(LampBrightness lampBrightness)

Sets the value of field 'lampBrightness'. The field 'lampBrightness' has the following description: Indicates the intensity of the lamp if it is on (as indicated by lampMode parameter). Actual visible brightness levels are lamp-dependent. Optional.

The complete set of possible values is:

• Unspecified/Normal (default)
• Dim
• Bright

Parameters:

lampBrightness - the value of field 'lampBrightness'.

setLampColor

public void setLampColor(java.lang.Short lampColor)

Sets the value of field 'lampColor'. The field 'lampColor' has the following description: A value from 0 - 100 specifying the color of the lamp. Mandatory.

Parameters:

lampColor - the value of field 'lampColor'.

setLampLabel

public void setLampLabel(java.lang.String lampLabel)

Sets the value of field 'lampLabel'. The field 'lampLabel' has the following description: Specifies the label by which the lamp may be referenced. Not supported.

Parameters:

lampLabel - the value of field 'lampLabel'.

setLampMode

public void setLampMode(java.lang.Short lampMode)

Sets the value of field 'lampMode'. The field 'lampMode' has the following description: Specifies how the lamp is lit. Mandatory.

A value from 0 - 100 specifying how the lamp is lit (flutter, off, steady, etc.)

Parameters:

lampMode - the value of field 'lampMode'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

unmarshalLampModeEvent

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

Method unmarshalLampModeEvent

Parameters:

reader -

Returns:

LampModeEvent

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