4.1.0.610 20071213

ch.ecma.csta.binding
Class SetLampMode

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

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

This request is not supported.

Sets the lamp mode status of a specified button on a device. Allows a computing function to control how a specified lamp is lit at a specified device.

The monitoring event sequence is a LampModeEvent for both device-type and call-type monitoring.

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

Constructor Summary
SetLampMode()
           
 
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'.
 LampBrightness getLampBrightness()
          Returns the value of field 'lampBrightness'.
 java.lang.Short getLampColor()
          Returns the value of field 'lampColor'.
 java.lang.Short getLampMode()
          Returns the value of field 'lampMode'.
 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'.
 void setLampBrightness(LampBrightness lampBrightness)
          Sets the value of field 'lampBrightness'.
 void setLampColor(java.lang.Short lampColor)
          Sets the value of field 'lampColor'.
 void setLampMode(java.lang.Short lampMode)
          Sets the value of field 'lampMode'.
static SetLampMode unmarshalSetLampMode(java.io.Reader reader)
          Method unmarshalSetLampMode
 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

SetLampMode

public SetLampMode()
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 the lampID of the lamp on the device. Mandatory.

Returns:
String

getLampBrightness

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

The complete set of possible values is:

Returns:
LampBrightness

getLampColor

public java.lang.Short getLampColor()
Returns the value of field 'lampColor'. The field 'lampColor' has the following description: Specifies the color of the lamp. Optional.

The meaning of the following values are pre-assigned:

Returns:
Short

getLampMode

public java.lang.Short getLampMode()
Returns the value of field 'lampMode'. The field 'lampMode' has the following description: Specifies how the lamp associated with the specified device should be lit. Mandatory.

The complete set of possible values is:

Returns:
Short

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 the lampID of the lamp on the device. 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 intensity of lamp when the lamp is on (as indicated by lampMode parameter). Actual visible brightness levels are lamp-dependent. Optional.

The complete set of possible values is:

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: Specifies the color of the lamp. Optional.

The meaning of the following values are pre-assigned:

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

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 associated with the specified device should be lit. Mandatory.

The complete set of possible values is:

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

unmarshalSetLampMode

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

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