ch.ecma.csta.binding
Class RetrieveCall

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

All Implemented Interfaces:

java.io.Serializable

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

Connects to a call that had previously been placed on hold.

The RetrieveCall request has these parameters:

RetrieveCall Request Parameters
callToBeRetrieved	Mandatory	Specifies the held connection to be retrieved.

CSTA Functional Requirements:

1. The Retrieve Call service may only be requested for a connection at a device's physical element if there is no other connected connection already present at the device's physical element. A device's physical elements can only interact with one voice call at a time so if an attempt is made to retrieve a call while another voice call is connected, the switching function sends a negative acknowledgement to the Retrieve Call service request.
2. Not applicable as it pertains to connectionReservation parameter which is not supported.
3. There may or may not be a media stream channel(s) available for the call on hold. In the case where a media stream channel(s) is not available, the switching function is unable to comply with the service request. In this case the switching function will send either a negative acknowledgement or the Service Completion Failure event, depending upon the acknowledgement model.
4. Not supported as it applies to bridging.

Negative Acknowledgements:

• systemResourceAvailability:conferenceMemberLimitExceeded - Sent if the maximum number of parties are on the conference.
• stateIncompatibility:generic Thrown if the user was on-hook when the request was made and he/she did not go off-hook within five seconds (call remains on hold)
• operation:invalidConnectionID - Sent if the connection identifier contained in the request is invalid or does not correspond to a station.
• operation:invalidDeviceID - Sent if invalid device ID specified in callToBeRetrieved.
• operation:parameterTypeNotSupported - Sent if callToBeRetrieved contains a DynamicID.
• stateIncompatibility:noActiveCall - Sent if the specified call at the station is cleared so it can not be retrieved.
• stateIncompatibility:noHeldCall - Sent if the specified call at the station is not in the held state so it can not be retrieved.
• 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

RetrieveCall()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
ConnectionID	getCallToBeRetrieved() Returns the value of field 'callToBeRetrieved'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setCallToBeRetrieved(ConnectionID callToBeRetrieved) Sets the value of field 'callToBeRetrieved'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
static RetrieveCall	unmarshalRetrieveCall(java.io.Reader reader) Method unmarshalRetrieveCall
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

RetrieveCall

public RetrieveCall()

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

getCallToBeRetrieved

public ConnectionID getCallToBeRetrieved()

Returns the value of field 'callToBeRetrieved'. The field 'callToBeRetrieved' has the following description: Specifies the held connection to be retrieved. Mandatory.

Returns:

ConnectionID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

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

setCallToBeRetrieved

public void setCallToBeRetrieved(ConnectionID callToBeRetrieved)

Sets the value of field 'callToBeRetrieved'. The field 'callToBeRetrieved' has the following description: Specifies the held connection to be retrieved. Mandatory.

Parameters:

callToBeRetrieved - the value of field 'callToBeRetrieved'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

unmarshalRetrieveCall

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

Method unmarshalRetrieveCall

Parameters:

reader -

Returns:

RetrieveCall

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