ch.ecma.csta.binding
Class CallBackMessage

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

All Implemented Interfaces:

java.io.Serializable

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

Not supported.

Allows a computing function to instruct the switching function to leave a pre-defined message requesting that the called device call the calling device. For example, the called device may have been busy when called.

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

Connection State Transitions:

• The callbackMessageConnection 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, 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.5.3.2, Table 17-25 "Call Back Message 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.5.3.3, Table 17-26 "Call Back Message Call-Related - Call-Type Monitoring Event Sequences" for a table describing the sequence of events for call-type monitoring.

CSTA Functional Requirements:

1. Only one Call Back Message 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 Message service requests (Call-Related or Non-Call-Related) for that pair result in a positive or negative acknowledgement from the switching function.
2. To cancel a Call Back Message (Call-Related or Non-Call-Related), the computing function will issue the Cancel Call Back Message service, alternatively the Call Back Message should be manually canceled.
3. The Call Back Message service (Call-Related or Non-Call-Related) differs from the CallBack service in that with the Call Back Message service, the calling device will not call back the called device. Instead, this service leaves a message at the called device.
4. The switching function defines the message left at the called device. A computing function cannot use the service to specify the message content or how the switching function will notify the user (for example, text message, voice message, indicator only).

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

CallBackMessage()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
ConnectionID	getCallbackMessageConnection() Returns the value of field 'callbackMessageConnection'.
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	setCallbackMessageConnection(ConnectionID callbackMessageConnection) Sets the value of field 'callbackMessageConnection'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
static CallBackMessage	unmarshalCallBackMessage(java.io.Reader reader) Method unmarshalCallBackMessage
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

CallBackMessage

public CallBackMessage()

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

getCallbackMessageConnection

public ConnectionID getCallbackMessageConnection()

Returns the value of field 'callbackMessageConnection'. The field 'callbackMessageConnection' has the following description: Specifies the call back message connection at the calling device. 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

setCallbackMessageConnection

public void setCallbackMessageConnection(ConnectionID callbackMessageConnection)

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

Parameters:

callbackMessageConnection - the value of field 'callbackMessageConnection'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

unmarshalCallBackMessage

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

Method unmarshalCallBackMessage

Parameters:

reader -

Returns:

CallBackMessage

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