ch.ecma.csta.binding
Class CallBack

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

All Implemented Interfaces:

java.io.Serializable

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

Not supported.

Allows a computing function to request that an originally called device return a call to the original calling device. This service allows a computing function to request that the calling device retry the call to the called device when the called device is in an appropriate state to accept the call.

As an example, the service might be used when a called device was busy so that the call is reattempted when the device becomes free.

For an illustration of this event, see ECMA 269, section 17.1.4, Figure 17-4 "Call Back Call-Related Service".
See Connection Failure for a complete description of "Call ID only" connection IDs.

Connection State Transitions:

• The callback connection will transition from an allowable initial state of Connected to one of the allowable final states of Null or Fail (see notes #1).
• The called connection will transition from one of the allowable initial states of Fail, Alerting, Queued, or Null (for example, null if call was forwarded or deflected from D2) to an allowable final state of Null.

Connection state transitions notes:

1. A device may transition to the Fail state prior to Null if the device stays off-hook and receives busy or blocked tone.
2. In the case where a call is forwarded from a called device (busy forwarding, for example), it is switching function dependent if the call back request is placed on the called device or the device that the call was forwarded to.

See ECMA 269, section 17.1.4.3.2, Table 17-20 "Call Back Call-Related - Device-Type Monitoring Event Sequences" for a table describing the sequence of events for device-type monitoring.

See ECMA 269, section 17.1.4.3.3, Table 17-21 "Call Back Call-Related - Call-Type Monitoring Event Sequences" for a table describing the sequence of events for call-type monitoring.

CSTA Functional Requirements:

1. Call Back Call-Related is similar to the CamponCall service. However for the Call Back Call-Related service the original call is cleared, but for the Camp On Call service, the call is queued.
2. Only one Call Back service request (Call-Related or Non-Call-Related) can be outstanding for any calling and called device pair. It is a switching function option (as indicated by the capability exchange services) if additional Call Back service requests (Call-Related or Non-Call-Related) for that pair result in a positive or negative acknowledgement from the switching function.
3. To cancel a Call Back (Call-Related or Non-Call-Related), the computing function will issue the Cancel Call Back service, alternatively the Call Back can be manually canceled.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

CallBack()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
ConnectionID	getCallbackConnection() Returns the value of field 'callbackConnection'.
CallCharacteristics	getCallCharacteristics() Returns the value of field 'callCharacteristics'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getLanguagePreferences() Returns the value of field 'languagePreferences'.
java.lang.String	getSubjectOfCall() Returns the value of field 'subjectOfCall'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setCallbackConnection(ConnectionID callbackConnection) Sets the value of field 'callbackConnection'.
void	setCallCharacteristics(CallCharacteristics callCharacteristics) Sets the value of field 'callCharacteristics'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setLanguagePreferences(java.lang.String languagePreferences) Sets the value of field 'languagePreferences'.
void	setSubjectOfCall(java.lang.String subjectOfCall) Sets the value of field 'subjectOfCall'.
static CallBack	unmarshalCallBack(java.io.Reader reader) Method unmarshalCallBack
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

CallBack

public CallBack()

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

getCallCharacteristics

public CallCharacteristics getCallCharacteristics()

Returns the value of field 'callCharacteristics'.

Returns:

CallCharacteristics

getCallbackConnection

public ConnectionID getCallbackConnection()

Returns the value of field 'callbackConnection'. The field 'callbackConnection' has the following description: Specifies the call back connection at the calling device. Mandatory.

Returns:

ConnectionID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getLanguagePreferences

public java.lang.String getLanguagePreferences()

Returns the value of field 'languagePreferences'.

Returns:

String

getSubjectOfCall

public java.lang.String getSubjectOfCall()

Returns the value of field 'subjectOfCall'.

Returns:

String

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

setCallCharacteristics

public void setCallCharacteristics(CallCharacteristics callCharacteristics)

Sets the value of field 'callCharacteristics'.

Parameters:

callCharacteristics - the value of field 'callCharacteristics'.

setCallbackConnection

public void setCallbackConnection(ConnectionID callbackConnection)

Sets the value of field 'callbackConnection'. The field 'callbackConnection' has the following description: Specifies the call back connection at the calling device. Mandatory.

Parameters:

callbackConnection - the value of field 'callbackConnection'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setLanguagePreferences

public void setLanguagePreferences(java.lang.String languagePreferences)

Sets the value of field 'languagePreferences'.

Parameters:

languagePreferences - the value of field 'languagePreferences'.

setSubjectOfCall

public void setSubjectOfCall(java.lang.String subjectOfCall)

Sets the value of field 'subjectOfCall'.

Parameters:

subjectOfCall - the value of field 'subjectOfCall'.

unmarshalCallBack

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

Method unmarshalCallBack

Parameters:

reader -

Returns:

CallBack

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