ch.ecma.csta.binding
Class GetHookswitchStatus

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

All Implemented Interfaces:

java.io.Serializable

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

Gets the hookswitch status of a specified device. This service provides the hookswitch status of one or more hookswitches associated with a specified device. The hookswitch status indicates which hookswitches are present on a device and which hookswitches are currently off-hook.

The GetHookswitchStatus request has these parameters:

GetHookswitchStatus Request Parameters
device	Mandatory	Specifies the physical element of the device.
hookswitch	Not used
extensions	Not used

Negative Acknowledgements:

• operation:invalidDeviceID - Sent if there is no station associated with the DeviceID
• stateIncompatibility:invalidDeviceState - Sent if the station is not available to use - not registered yet
• operation:generic - Sent if a operational error has occurred
• operation:serviceNotSupported - Sent if the requested service is not supported
• unspecified - Sent if an implementation specific error occurred.

The hookswitch status is returned in the response. The GetHookswitchStatusResponse contains these parameters:

GetHookswitchStatusResponse Parameters
hookswitchStatusList	Always provided	Specifies information about the hookswitch. The item in the list is of type HookswitchStatusItem. Its contents are shown below.
extensions	Not Used

The item in the response's hookswitchStatusList is of type HookswitchStatusItem. It contains these parameters:

HookswitchStatusItem Parameters
hookswitch	A string that identifies the hookswitch whose status is reported.
hookswitchOnHook	A Boolean that indicates the state of the hookswitch. The complete set of possible values is: true - Indicates that the switch is onhook. false - Indicates that the switch is offhook.

There are no events generated from this service.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

GetHookswitchStatus()

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	getHookswitch() Returns the value of field 'hookswitch'.
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	setHookswitch(java.lang.String hookswitch) Sets the value of field 'hookswitch'.
static GetHookswitchStatus	unmarshalGetHookswitchStatus(java.io.Reader reader) Method unmarshalGetHookswitchStatus
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

GetHookswitchStatus

public GetHookswitchStatus()

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

getHookswitch

public java.lang.String getHookswitch()

Returns the value of field 'hookswitch'. The field 'hookswitch' has the following description: Specifies which hookswitch to query. If not provided, then information is obtained on all the hookswitches associated with the device. Not supported.

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

setHookswitch

public void setHookswitch(java.lang.String hookswitch)

Sets the value of field 'hookswitch'. The field 'hookswitch' has the following description: Specifies which hookswitch to query. If not provided, then information is obtained on all the hookswitches associated with the device. Not supported.

Parameters:

hookswitch - the value of field 'hookswitch'.

unmarshalGetHookswitchStatus

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

Method unmarshalGetHookswitchStatus

Parameters:

reader -

Returns:

GetHookswitchStatus

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