4.1.0.610 20071213

ch.ecma.csta.binding
Class SetHookswitchStatus

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

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

Sets the hookswitch status of a specified device. The Set Hookswitch Status service allows the computing function to activate and deactivate (go offhook/onhook) an auditory apparatus (for example, speakerphone, handset, headset) at a specified device.

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

The SetHookswitchStatus request has these parameters:

SetHookswitchStatus Request Parameters
device Mandatory Specifies the physical element of the device.
hookswitch Mandatory Specifies the hookswitch whose status is to be set. This field is currently ignored. Communication Manager only allows one hookswitch. However, CSTA requires that you set the hookswitch to a 4-digit string. We recommend "0000".
hookswitchOnHook Mandatory Specifies the state the hookswitch is to be set to. The complete set of possible values is:
  • true - go onhook
  • false - go offhook
extensions Not Used

Negative Acknowledgements:

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

Constructor Summary
SetHookswitchStatus()
           
 
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'.
 java.lang.Boolean getHookswitchOnhook()
          Returns the value of field 'hookswitchOnhook'.
 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'.
 void setHookswitchOnhook(java.lang.Boolean hookswitchOnhook)
          Sets the value of field 'hookswitchOnhook'.
static SetHookswitchStatus unmarshalSetHookswitchStatus(java.io.Reader reader)
          Method unmarshalSetHookswitchStatus
 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

SetHookswitchStatus

public SetHookswitchStatus()
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 the hookswitch whose status is to be set. This field is currently ignored. Communication Manager only allows one hookswitch. However, CSTA requires that you set the hookswitch to a 4-digit string. We recommend "0000".Mandatory.

Returns:
String

getHookswitchOnhook

public java.lang.Boolean getHookswitchOnhook()
Returns the value of field 'hookswitchOnhook'.

Returns:
Boolean

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 the hookswitch whose status is to be set. This field is currently ignored. Communication Manager only allows one hookswitch. However, CSTA requires that you set the hookswitch to a 4-digit string. We recommend "0000".Mandatory.

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

setHookswitchOnhook

public void setHookswitchOnhook(java.lang.Boolean hookswitchOnhook)
Sets the value of field 'hookswitchOnhook'.

Parameters:
hookswitchOnhook - the value of field 'hookswitchOnhook'

unmarshalSetHookswitchStatus

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

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