ch.ecma.csta.binding
Class AlternateCall

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

All Implemented Interfaces:

java.io.Serializable

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

Places an existing call on hold and then retrieves a previously held or alerting call at the same device. This service is also used to place an active call on hold and then connect to an alerting or queued call at the same device (that is, to answer a call-waiting call).

The AlternateCall request has these parameters:

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

CSTA Functional Requirements:

1. The Alternate Call service should not be used to put an alerting call on hold and re-connect to another call that is on hold.
2. This service is a multiple step service that is equivalent to the computing function issuing the HoldCall service for the activeCall ConnectionID and then issuing one of the following services:
   • a RetrieveCall service for the heldCall ConnectionID.
   • an AnswerCall service for the heldCall ConnectionID.
   • an AcceptCall service for the heldCall ConnectionID.
3. Not Supported
4. Not supported as it applies to bridging.

Negative Acknowledgements:

• operation:invalidDeviceID - Sent if the specified DeviceID for the held call or active call is not valid.
• operation:invalidConnectionID - Sent if the specified ConnectionID is not valid. The call may have ended.
• stateIncompatibility:invalidConnectionIDForActiveCall - Sent if the controlling DeviceID in the active call and held call is different.
• stateIncompatibility:invalidConnectionState - Sent if the heldcall is not in the alerting, connected, held, or bridged state.
• operation:securityViolation - Sent if the user was not authorized to control the specified device.
• stateIncompatibility:noActiveCall - Sent if the activeCall to be put on hold is not currently active (in alerting state, for example) so it cannot be put on hold.
• systemResourceAvailability:generic - Sent if the client attempted to add a seventh party (otherCall) to a call with six active parties.
• systemResourceAvailability:resourceBusy - Sent if the user at the heldCall station is busy on a call or there is no idle appearance available. It is also possible that the switch is busy with another CSTA request.
• stateIncompatibility:generic - Sent if the heldCall station user did not go off-hook within five seconds and is not capable of being forced off-hook.
• subscribedResourceAvailability:outstandingReqLimitExceeded - Sent if the client attempted to put a third party (activeCall) on hold (two parties are on hold already) on an analog station.
• 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

AlternateCall()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
ConnectionID	getActiveCall() Returns the value of field 'activeCall'.
java.lang.Boolean	getConnectionReservation() Returns the value of field 'connectionReservation'.
ConsultOptions	getConsultOptions() Returns the value of field 'consultOptions'.
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	setConnectionReservation(java.lang.Boolean connectionReservation) Sets the value of field 'connectionReservation'.
void	setConsultOptions(ConsultOptions consultOptions) Sets the value of field 'consultOptions'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setHeldCall(ConnectionID heldCall) Sets the value of field 'heldCall'.
static AlternateCall	unmarshalAlternateCall(java.io.Reader reader) Method unmarshalAlternateCall
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

AlternateCall

public AlternateCall()

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 for the alternating device. Mandatory.

Returns:

ConnectionID

getConnectionReservation

public java.lang.Boolean getConnectionReservation()

Returns the value of field 'connectionReservation'. The field 'connectionReservation' has the following description: Specifies that the media stream channel(s) associated with the call being placed on hold be reserved for reuse at a later time. Optional.

The complete set of possible values is:

• True - channel(s) is to be reserved.
• False - channel(s) is not to be reserved (default).

Returns:

Boolean

getConsultOptions

public ConsultOptions getConsultOptions()

Returns the value of field 'consultOptions'.

Returns:

ConsultOptions

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 for the alternating device. 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 for the alternating device. Mandatory.

Parameters:

activeCall - the value of field 'activeCall'.

setConnectionReservation

public void setConnectionReservation(java.lang.Boolean connectionReservation)

Sets the value of field 'connectionReservation'. The field 'connectionReservation' has the following description: Specifies that the media stream channel(s) associated with the call being placed on hold be reserved for reuse at a later time. Optional.

The complete set of possible values is:

• True - channel(s) is to be reserved.
• False - channel(s) is not to be reserved (default).

Parameters:

connectionReservation - the value of field 'connectionReservation'.

setConsultOptions

public void setConsultOptions(ConsultOptions consultOptions)

Sets the value of field 'consultOptions'.

Parameters:

consultOptions - the value of field 'consultOptions'.

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 for the alternating device. Mandatory.

Parameters:

heldCall - the value of field 'heldCall'.

unmarshalAlternateCall

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

Method unmarshalAlternateCall

Parameters:

reader -

Returns:

AlternateCall

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