ch.ecma.csta.binding
Class ButtonPressEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Not implemented.

Indicates that a button has been pressed.

This event may be generated in any one of the following ways:

• The button has been pressed manually.
• A computing function, on behalf of a user, has invoked the ButtonPress service.

The Button Press event is only provided when the button is physically pressed or when the Button Press service is used. It is not to be used to track the function that the button represents.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

ButtonPressEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
java.lang.String	getButton() Returns the value of field 'button'.
DeviceID	getButtonAssociatedNumber() Returns the value of field 'buttonAssociatedNumber'.
java.lang.String	getButtonLabel() Returns the value of field 'buttonLabel'.
SubjectDeviceID	getDevice() Returns the value of field 'device'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
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	setButton(java.lang.String button) Sets the value of field 'button'.
void	setButtonAssociatedNumber(DeviceID buttonAssociatedNumber) Sets the value of field 'buttonAssociatedNumber'.
void	setButtonLabel(java.lang.String buttonLabel) Sets the value of field 'buttonLabel'.
void	setDevice(SubjectDeviceID device) Sets the value of field 'device'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
static ButtonPressEvent	unmarshalButtonPressEvent(java.io.Reader reader) Method unmarshalButtonPressEvent
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

ButtonPressEvent

public ButtonPressEvent()

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 the button that was pressed.

Returns:

String

getButtonAssociatedNumber

public DeviceID getButtonAssociatedNumber()

Returns the value of field 'buttonAssociatedNumber'. The field 'buttonAssociatedNumber' has the following description: Indicates a number (in diallable string format) associated with the button.

Returns:

DeviceID

getButtonLabel

public java.lang.String getButtonLabel()

Returns the value of field 'buttonLabel'. The field 'buttonLabel' has the following description: Specifies the label by which the button may be referenced.

Returns:

String

getDevice

public SubjectDeviceID getDevice()

Returns the value of field 'device'. The field 'device' has the following description: Specifies the device where the button press feature was changed.

Returns:

SubjectDeviceID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

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

setButton

public void setButton(java.lang.String button)

Sets the value of field 'button'. The field 'button' has the following description: Specifies the button that was pressed.

Parameters:

button - the value of field 'button'.

setButtonAssociatedNumber

public void setButtonAssociatedNumber(DeviceID buttonAssociatedNumber)

Sets the value of field 'buttonAssociatedNumber'. The field 'buttonAssociatedNumber' has the following description: Indicates a number (in diallable string format) associated with the button.

Parameters:

buttonAssociatedNumber - the value of field 'buttonAssociatedNumber'.

setButtonLabel

public void setButtonLabel(java.lang.String buttonLabel)

Sets the value of field 'buttonLabel'. The field 'buttonLabel' has the following description: Specifies the label by which the button may be referenced.

Parameters:

buttonLabel - the value of field 'buttonLabel'.

setDevice

public void setDevice(SubjectDeviceID device)

Sets the value of field 'device'. The field 'device' has the following description: Specifies the device where the button press feature was changed.

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

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

unmarshalButtonPressEvent

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

Method unmarshalButtonPressEvent

Parameters:

reader -

Returns:

ButtonPressEvent

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