ch.ecma.csta.binding
Class AnswerCall

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

All Implemented Interfaces:

java.io.Serializable

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

Answers a call that is ringing, queued, or being offered to a device. This service is typically associated with devices that have attached speakerphone units and headset telephones to connect to a call via hands-free operation. For example, when the call is answered, one of the following actions may occur:

• If the specified device has a speaker and a microphone, the speaker and microphone are turned on.
• If the specified device only has a speaker, the speaker is turned on. The handset must be picked up in order to have a two way conversation.
• If there is no speaker, then the handset must be picked up in order to have a two-way conversation.
• If the specified device has a headset, the headset is turned on.

The AnswerCall request has these parameters:

AnswerCall Request Parameters
callToBeAnswered	Mandatory	Alerting connection to be answered

CSTA Functional Requirements:

1. If the computing function wants to clear an active call prior to answering an alerting or queued call for a device, it must first issue a ClearConnection service for the active call and then issue the Answer Call service for the alerting or queued call.

Negative Acknowledgements:

• stateIncompatibility:invalidCalledDeviceState - Sent if the station user did not go off-hook within five seconds and is not capable of being forced off-hook.
• systemResourceAvailability:generic - Sent if the client attempted to add a seventh party to a call with six active participants.
• operation:invalidConnectionID - Sent if an invalid connection ID specified.
• operation:InvalidDeviceID - Sent if an invalid device ID is specified in callToBeAnswered
• stateIncompatibility:invalidConnectionState - Sent if the specified connection is not in a valid state for this operation.
• stateIncompatibility:noCallToAnswer - Sent if the call has been redirected to coverage.
• systemResourceAvailability:ResourceBusy - Sent if the user is busy or there is no idle appearance available.
• 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

AnswerCall()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
ConnectionID	getCallToBeAnswered() Returns the value of field 'callToBeAnswered'.
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
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	setCallToBeAnswered(ConnectionID callToBeAnswered) Sets the value of field 'callToBeAnswered'.
void	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static AnswerCall	unmarshalAnswerCall(java.io.Reader reader) Method unmarshalAnswerCall
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

AnswerCall

public AnswerCall()

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

getCallToBeAnswered

public ConnectionID getCallToBeAnswered()

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

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

setCallToBeAnswered

public void setCallToBeAnswered(ConnectionID callToBeAnswered)

Sets the value of field 'callToBeAnswered'. The field 'callToBeAnswered' has the following description: Specifies the connection to be answered. Mandatory.

Parameters:

callToBeAnswered - the value of field 'callToBeAnswered'

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

setUserData

public void setUserData(UserData userData)

Sets the value of field 'userData'.

Parameters:

userData - the value of field 'userData'.

unmarshalAnswerCall

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

Method unmarshalAnswerCall

Parameters:

reader -

Returns:

AnswerCall

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