ch.ecma.csta.binding
Class DeflectCall

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

All Implemented Interfaces:

java.io.Serializable

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

Deflects a call to another device. This service allows the computing function to divert a call to another destination that may be inside or outside the switching sub-domain.

The DeflectCall request has these parameters:

DeflectCall Request Parameters
callToBeDiverted	Mandatory	Specifies the connection to be diverted.
newDestination	Mandatory	Specifies the device to which the call is to be diverted.

CSTA Functional Requirements:

1. The Deflect Call service differs from the (Directed and Group) Pickup services in that the Pickup services redirects a call from a device and connects it to a specified device.
2. The Deflect Call service only affects the callToBeDiverted ConnectionID's call. If other calls exist at the callToBeDiverted ConnectionID's device, they remain unaffected.
3. For the newDestination, all active features for this device will be honoured while the call is being deflected to it. For example, due to active features at the called device, the call may or may not be deflected to the new destination device.
4. As a result of the Deflect Call service, the call ID associated with this call remains unchanged.
5. If the callToBeDiverted connection identifier is associated with a shared bridged device configuration appearance in the queued state (that is, inactive mode), then the service request will be rejected with a negative acknowledgement.
6. This service request does not support the use of a null device identifier or a Diallable Digits format (DD) device identifier that has a partial dialling sequence character (that is, the ";" character) in it for the newDestination parameter. A complete and valid device identifier will be provided, otherwise the switching function will reject the service request with a negative acknowledgement.
7. Not supported as it applies to digital data call.

Negative Acknowledgements:

• systemResourceAvailability:resourceBusy - Sent if call redirected to a busy station, a station that has call forwarding active, or a TEG group with one or more members busy will be rejected with this error.
• operation:securityViolationException Thrown if the user was not authorized to control the specified device.
• unspecified - Sent if an implementation specific error occurred.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

DeflectCall()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
ConnectionID	getCallToBeDiverted() Returns the value of field 'callToBeDiverted'.
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getLanguagePreferences() Returns the value of field 'languagePreferences'.
DeviceID	getNewDestination() Returns the value of field 'newDestination'.
EventCause	getReason() Returns the value of field 'reason'.
java.lang.String	getSubjectOfCall() Returns the value of field 'subjectOfCall'.
UserData	getUserData() Returns the value of field 'userData'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setCallToBeDiverted(ConnectionID callToBeDiverted) Sets the value of field 'callToBeDiverted'.
void	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setLanguagePreferences(java.lang.String languagePreferences) Sets the value of field 'languagePreferences'.
void	setNewDestination(DeviceID newDestination) Sets the value of field 'newDestination'.
void	setReason(EventCause reason) Sets the value of field 'reason'.
void	setSubjectOfCall(java.lang.String subjectOfCall) Sets the value of field 'subjectOfCall'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static DeflectCall	unmarshalDeflectCall(java.io.Reader reader) Method unmarshalDeflectCall
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

DeflectCall

public DeflectCall()

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

getCallToBeDiverted

public ConnectionID getCallToBeDiverted()

Returns the value of field 'callToBeDiverted'. The field 'callToBeDiverted' has the following description: Specifies the connection to be diverted. Mandatory.

Returns:

ConnectionID

getCorrelatorData

public CorrelatorData getCorrelatorData()

Returns the value of field 'correlatorData'.

Returns:

CorrelatorData

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getLanguagePreferences

public java.lang.String getLanguagePreferences()

Returns the value of field 'languagePreferences'.

Returns:

String

getNewDestination

public DeviceID getNewDestination()

Returns the value of field 'newDestination'. The field 'newDestination' has the following description: Specifies the device to which the call is to be diverted. Mandatory.

Returns:

DeviceID

getReason

public EventCause getReason()

Returns the value of field 'reason'.

Returns:

EventCause

getSubjectOfCall

public java.lang.String getSubjectOfCall()

Returns the value of field 'subjectOfCall'.

Returns:

String

getUserData

public UserData getUserData()

Returns the value of field 'userData'.

Returns:

UserData

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

setCallToBeDiverted

public void setCallToBeDiverted(ConnectionID callToBeDiverted)

Sets the value of field 'callToBeDiverted'. The field 'callToBeDiverted' has the following description: Specifies the connection to be diverted. Mandatory.

Parameters:

callToBeDiverted - the value of field 'callToBeDiverted'

setCorrelatorData

public void setCorrelatorData(CorrelatorData correlatorData)

Sets the value of field 'correlatorData'.

Parameters:

correlatorData - the value of field 'correlatorData'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setLanguagePreferences

public void setLanguagePreferences(java.lang.String languagePreferences)

Sets the value of field 'languagePreferences'.

Parameters:

languagePreferences - the value of field 'languagePreferences'.

setNewDestination

public void setNewDestination(DeviceID newDestination)

Sets the value of field 'newDestination'. The field 'newDestination' has the following description: Specifies the device to which the call is to be diverted. Mandatory.

Parameters:

newDestination - the value of field 'newDestination'.

setReason

public void setReason(EventCause reason)

Sets the value of field 'reason'.

Parameters:

reason - the value of field 'reason'.

setSubjectOfCall

public void setSubjectOfCall(java.lang.String subjectOfCall)

Sets the value of field 'subjectOfCall'.

Parameters:

subjectOfCall - the value of field 'subjectOfCall'.

setUserData

public void setUserData(UserData userData)

Sets the value of field 'userData'.

Parameters:

userData - the value of field 'userData'.

unmarshalDeflectCall

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

Method unmarshalDeflectCall

Parameters:

reader -

Returns:

DeflectCall

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