ch.ecma.csta.binding
Class GroupPickupCall

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

All Implemented Interfaces:

java.io.Serializable

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

This request is not supported.

Moves a call that is a member of a specified or default pickup group to a new specified destination.

This results in a connection in a pickup group to be connected to a new specified destination inside the switching sub-domain.

Note that the difference between this service and the DirectedPickupCall service is that Directed Pickup Call service specifies the actual connection to be picked up whereby the Group Pickup Call service does not.

For an illustration of this event, see ECMA 269, section 17.1.14, Figure 17-15 "Group Pickup Call Service".

Connection State Transitions:

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

See ECMA 269, section 17.1.14.3.2, Table 17-76 "Group 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.14.3.3, Table 17-77 "Group 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 Group Pickup Call service redirects a call to another destination which is immediately connected to the call.
2. The Group Pickup service is administered by the switching function. The switching function determines which call the newDestination connects to by first determining which group the newDestination belongs to (either as specified by the pickGroup parameter or by a switching function administered group associated with the newDestination device) and then connecting it to the appropriate call.
3. 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.
4. As a result of the Group Pickup service, the call ID associated with this call remains unchanged.
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 or pickGroup parameters. A complete and valid device identifier will be provided, otherwise the switching function will reject the service request with a negative acknowledgement.
6. For Shared Bridged device configurations, when a call is picked from an appearance 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 Annex A.2.3, "Shared-Bridged".

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

GroupPickupCall()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
DeviceID	getNewDestination() Returns the value of field 'newDestination'.
DeviceID	getPickGroup() Returns the value of field 'pickGroup'.
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	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setNewDestination(DeviceID newDestination) Sets the value of field 'newDestination'.
void	setPickGroup(DeviceID pickGroup) Sets the value of field 'pickGroup'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static GroupPickupCall	unmarshalGroupPickupCall(java.io.Reader reader) Method unmarshalGroupPickupCall
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

GroupPickupCall

public GroupPickupCall()

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

getCorrelatorData

public CorrelatorData getCorrelatorData()

Returns the value of field 'correlatorData'.

Returns:

CorrelatorData

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getNewDestination

public DeviceID getNewDestination()

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

Returns:

DeviceID

getPickGroup

public DeviceID getPickGroup()

Returns the value of field 'pickGroup'. The field 'pickGroup' has the following description: Specifies the pick group. Optional. If this parameter is not provided, the switching function may use a pick group associated with the newDestination device.

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

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

setNewDestination

public void setNewDestination(DeviceID newDestination)

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

Parameters:

newDestination - the value of field 'newDestination'.

setPickGroup

public void setPickGroup(DeviceID pickGroup)

Sets the value of field 'pickGroup'. The field 'pickGroup' has the following description: Specifies the pick group. Optional. If this parameter is not provided, the switching function may use a pick group associated with the newDestination device.

Parameters:

pickGroup - the value of field 'pickGroup'.

setUserData

public void setUserData(UserData userData)

Sets the value of field 'userData'.

Parameters:

userData - the value of field 'userData'.

unmarshalGroupPickupCall

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

Method unmarshalGroupPickupCall

Parameters:

reader -

Returns:

GroupPickupCall

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