ch.ecma.csta.binding
Class HookswitchEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Indicates that the switch has changed the device's hookswitch status. This event is not sent if your device explicitly goes onhook with a SetHookswitchStatus request. It only occurs when all other parties on the call drop or are dropped. The switch then automatically sets the device's hookswitch status to on hook.

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

• The application sent SetHookswitchStatus request.
• The hookswitch status has been changed manually.
• The computing function has invoked a call control service that indirectly affected the hookswitch.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

HookswitchEvent()

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	getHookswitch() Returns the value of field 'hookswitch'.
java.lang.Boolean	getHookswitchOnHook() Returns the value of field 'hookswitchOnHook'.
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	setHookswitch(java.lang.String hookswitch) Sets the value of field 'hookswitch'.
void	setHookswitchOnHook(java.lang.Boolean hookswitchOnHook) Sets the value of field 'hookswitchOnHook'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
static HookswitchEvent	unmarshalHookswitchEvent(java.io.Reader reader) Method unmarshalHookswitchEvent
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

HookswitchEvent

public HookswitchEvent()

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 feature was changed. Mandatory.

Returns:

SubjectDeviceID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getHookswitch

public java.lang.String getHookswitch()

Returns the value of field 'hookswitch'. The field 'hookswitch' has the following description: Specifies the hookswitch at the device where the feature was invoked. Mandatory.

Returns:

String

getHookswitchOnHook

public java.lang.Boolean getHookswitchOnHook()

Returns the value of field 'hookswitchOnHook'. The field 'hookswitchOnHook' has the following description: Specifies the state of the hookswitch. Mandatory.

The complete set of possible values is:

• On-hook - The switch is open and the hookswitch is inactive.
• Off-hook - The switch is closed and the hookswitch is active.

Returns:

Boolean

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

setHookswitch

public void setHookswitch(java.lang.String hookswitch)

Sets the value of field 'hookswitch'. The field 'hookswitch' has the following description: Specifies the hookswitch at the device where the feature was invoked. Mandatory.

Parameters:

hookswitch - the value of field 'hookswitch'.

setHookswitchOnHook

public void setHookswitchOnHook(java.lang.Boolean hookswitchOnHook)

Sets the value of field 'hookswitchOnHook'. The field 'hookswitchOnHook' has the following description: Specifies the state of the hookswitch. Mandatory.

The complete set of possible values is:

• On-hook - The switch is open and the hookswitch is inactive.
• Off-hook - The switch is closed and the hookswitch is active.

Parameters:

hookswitchOnHook - the value of field 'hookswitchOnHook'

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

unmarshalHookswitchEvent

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

Method unmarshalHookswitchEvent

Parameters:

reader -

Returns:

HookswitchEvent

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