ch.ecma.csta.binding
Class DirectedPickupCall

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

All Implemented Interfaces:

java.io.Serializable

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

This request is not supported.

Moves a specified call and connects it at a new specified destination. This results in the connection being diverted to a new destination inside the switching sub-domain.

For an illustration of this event, see ECMA 269, section 17.1.13, Figure 17-14 "Directed Pickup Call Service".

Connection State Transitions:

• The callToBePickedUp connection will transition from one of the allowable initial states of Alerting, Connect, Hold, or Queued to an allowable final states of Null.
• The calling device connection is unaffected (that is, there is no transition due to this service).
• The requestingDevice connection will transition from an allowable initial state of Null to an allowable final state of Connected.

See ECMA 269, section 17.1.13.3.2, Table 17-71 "Directed Pickup Call - Device-Type Monitoring Event Sequences" for a table describing the sequence of events for device-type monitoring.

See ECMA 269, section 17.1.13.3.3, Table 17-72 "Directed Pickup Call - Call-Type Monitoring Event Sequences" for a table describing the sequence of events for call-type monitoring.

CSTA Functional Requirements:

1. This service differs from the DeflectCall service in that the Deflect Call service redirects a call to another destination (in which the resulting state of the new destination depends on the destination's type and active features). The Directed Pickup Call service redirects a call to another destination which is immediately connected to the call.
2. For the newDestination, all features such as Forwarding and Do Not Disturb for this device will be ignored while the call is being redirected to it.
3. As a result of the Directed Pickup service, the call ID associated with this call remains unchanged.
4. For Shared Bridged device configurations, when a call is picked from an appearance (callToBePickedUp) all appearances will be cleared from the call (that is, Connection Cleared events with a cause of Normal), except when the call that is being picked is part of an Independent Shared Bridged device configuration and the appearance from which the call is being picked is not the last appearance connected into the call. In this case the appearance from which the call is being picked will return to the inactive mode (that is, Bridged event with a cause of Normal) and the other appearances are unaffected. For more information, refer to ECMA 269, section A.2.3, "Shared-Bridged".
5. 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.
6. This service is used when the device associated with the callToBePickedUp connection ID is different from the newDestination device. If the devices are the same, then the service is rejected. The Answer Call and the Retrieve Call services should be used instead.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

DirectedPickupCall()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
ConnectionID	getCallToBePickedUp() Returns the value of field 'callToBePickedUp'.
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
DeviceID	getRequestingDevice() Returns the value of field 'requestingDevice'.
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	setCallToBePickedUp(ConnectionID callToBePickedUp) Sets the value of field 'callToBePickedUp'.
void	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setRequestingDevice(DeviceID requestingDevice) Sets the value of field 'requestingDevice'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static DirectedPickupCall	unmarshalDirectedPickupCall(java.io.Reader reader) Method unmarshalDirectedPickupCall
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

DirectedPickupCall

public DirectedPickupCall()

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

getCallToBePickedUp

public ConnectionID getCallToBePickedUp()

Returns the value of field 'callToBePickedUp'. The field 'callToBePickedUp' has the following description: Specifies the connection to be picked up. 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

getRequestingDevice

public DeviceID getRequestingDevice()

Returns the value of field 'requestingDevice'. The field 'requestingDevice' has the following description: Specifies the device which is picking up the call. Mandatory.

Returns:

DeviceID

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

setCallToBePickedUp

public void setCallToBePickedUp(ConnectionID callToBePickedUp)

Sets the value of field 'callToBePickedUp'. The field 'callToBePickedUp' has the following description: Specifies the connection to be picked up. Mandatory.

Parameters:

callToBePickedUp - the value of field 'callToBePickedUp'

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

setRequestingDevice

public void setRequestingDevice(DeviceID requestingDevice)

Sets the value of field 'requestingDevice'. The field 'requestingDevice' has the following description: Specifies the device which is picking up the call. Mandatory.

Parameters:

requestingDevice - the value of field 'requestingDevice'

setUserData

public void setUserData(UserData userData)

Sets the value of field 'userData'.

Parameters:

userData - the value of field 'userData'.

unmarshalDirectedPickupCall

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

Method unmarshalDirectedPickupCall

Parameters:

reader -

Returns:

DirectedPickupCall

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