ch.ecma.csta.binding
Class TransferCall

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

All Implemented Interfaces:

java.io.Serializable

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

Transfers a call held at a device to an active call at the same device. The held and active calls at the transferring device will be merged into a new call. Also, the Connections of the held and active calls at the transferring device will become Null and their ConnectionIDs will be released (that is, the transferring device is no longer involved with the call).

The TransferCall request has these parameters:

TransferCall Request Parameters
heldCall	Mandatory	Held Connection.
activeCall	Mandatory	Active Connection.

CSTA Functional Requirements:

1. [AVAYA QUALIFIED] To get the connections for each of the devices to their initial states, the computing function can either:
   • Use the ConsultationCall service to place a call on hold and place a new call.
   • Use the AlternateCall service to place a call on hold and answer an alerting call.
   This product supports a third approach for preparing for the Transfer Call service involving the use of a hold service followed by a Make Call.
2. Not applicable as it pertains to consultOptions parameter which is not supported.
3. [AVAYA QUALIFIED] This product does not return the call to the transferring device if the Transfer Call service fails for any reason after the positive acknowledgement is returned.
4. Not supported as it applies to bridging.
5. [AVAYA QUALIFIED] This product does not reuse callIDs.

Negative Acknowledgements:

• systemResourceAvailability:conferenceMemberLimitExceeded - Sent if the maximum number of parties are on the conference.
• stateIncompatibility:generic - Sent if both calls are alerting. Both calls are being service-observed.
• An active call is in a vector-processing stage.
• stateIncompatibility:invalidConnectionIDForActiveCall - Sent if the callID in activeCall or heldCall has not been specified correctly.
• operation:invalidConnectionID - Sent if the controlling deviceID in activeCall or heldCall has not been specified correctly.
• operation:invalidDeviceID - Sent if an invalid device ID is specified in heldCall or activeCall.
• stateIncompatibility:invalidConnectionState - Sent if the connections specified in the request are not in the valid states for the operation to take place. For example, it does not have one active call and one held call as required.
• operation:parameterTypeNotSupported - Sent if DynamicID is specified for activeCall or heldCall.
• systemResourceAvailability:resourceBusy - Sent if the switch is busy with another CSTA request.
• operation:securityViolation - Sent if the user was not authorized to control the specified device.
• operation:generic - Sent if a logic error occurred in the code.
• unspecified - Sent if an implementation specific error occurred.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

TransferCall()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
ConnectionID	getActiveCall() Returns the value of field 'activeCall'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
ConnectionID	getHeldCall() Returns the value of field 'heldCall'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setActiveCall(ConnectionID activeCall) Sets the value of field 'activeCall'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setHeldCall(ConnectionID heldCall) Sets the value of field 'heldCall'.
static TransferCall	unmarshalTransferCall(java.io.Reader reader) Method unmarshalTransferCall
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

TransferCall

public TransferCall()

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

getActiveCall

public ConnectionID getActiveCall()

Returns the value of field 'activeCall'. The field 'activeCall' has the following description: Specifies the active connection. Mandatory.

Returns:

ConnectionID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getHeldCall

public ConnectionID getHeldCall()

Returns the value of field 'heldCall'. The field 'heldCall' has the following description: Specifies the held connection. Mandatory.

Returns:

ConnectionID

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

setActiveCall

public void setActiveCall(ConnectionID activeCall)

Sets the value of field 'activeCall'. The field 'activeCall' has the following description: Specifies the active connection. Mandatory.

Parameters:

activeCall - the value of field 'activeCall'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setHeldCall

public void setHeldCall(ConnectionID heldCall)

Sets the value of field 'heldCall'. The field 'heldCall' has the following description: Specifies the held connection. Mandatory.

Parameters:

heldCall - the value of field 'heldCall'.

unmarshalTransferCall

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

Method unmarshalTransferCall

Parameters:

reader -

Returns:

TransferCall

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