ch.ecma.csta.binding
Class LampItem

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

All Implemented Interfaces:

java.io.Serializable

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

Specifies information about a specified lamp.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

LampItem()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
java.lang.String	getButton() Returns the value of field 'button'.
java.lang.String	getLamp() Returns the value of field 'lamp'.
java.lang.Short	getLampColor() Returns the value of field 'lampColor'.
java.lang.String	getLampLabel() Returns the value of field 'lampLabel'.
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	setLamp(java.lang.String lamp) Sets the value of field 'lamp'.
void	setLampColor(java.lang.Short lampColor) Sets the value of field 'lampColor'.
void	setLampLabel(java.lang.String lampLabel) Sets the value of field 'lampLabel'.
static LampItem	unmarshalLampItem(java.io.Reader reader) Method unmarshalLampItem
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

LampItem

public LampItem()

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

getButton

public java.lang.String getButton()

Returns the value of field 'button'. The field 'button' has the following description: Specifies a button that is associated with this lamp. If not present, then a button is not associated with this lamp.

Returns:

String

getLamp

public java.lang.String getLamp()

Returns the value of field 'lamp'. The field 'lamp' has the following description: Indicates the lampID of this lamp. Mandatory.

Returns:

String

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. The meaning of the following values are pre-assigned:

• 0 - no color
• 1 - Red
• 2 - Yellow
• 3 - Green
• 4 - Blue
• 5 - Unknown (the switching function cannot determine the color of the lamp) (default if this parameter is not present).

All other values (6-100) are switching function specific.

Returns:

Short

getLampLabel

public java.lang.String getLampLabel()

Returns the value of field 'lampLabel'. The field 'lampLabel' has the following description: The label by which a lamp may be referenced. The maximum length supported by the switching function is provided via the capabilities exchange services. Optional.

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

setButton

public void setButton(java.lang.String button)

Sets the value of field 'button'. The field 'button' has the following description: Specifies a button that is associated with this lamp. If not present, then a button is not associated with this lamp.

Parameters:

button - the value of field 'button'.

setLamp

public void setLamp(java.lang.String lamp)

Sets the value of field 'lamp'. The field 'lamp' has the following description: Indicates the lampID of this lamp. Mandatory.

Parameters:

lamp - the value of field 'lamp'.

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. The meaning of the following values are pre-assigned:

• 0 - no color
• 1 - Red
• 2 - Yellow
• 3 - Green
• 4 - Blue
• 5 - Unknown (the switching function cannot determine the color of the lamp) (default if this parameter is not present).

All other values (6-100) are switching function specific.

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: The label by which a lamp may be referenced. The maximum length supported by the switching function is provided via the capabilities exchange services. Optional.

Parameters:

lampLabel - the value of field 'lampLabel'.

unmarshalLampItem

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

Method unmarshalLampItem

Parameters:

reader -

Returns:

LampItem

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