ch.ecma.csta.binding
Class MakePredictiveCall

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

All Implemented Interfaces:

java.io.Serializable

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

This request is not supported.

Establishes a call between two devices. The calling device is presented with the call only after the called device is alerted or has answered the call.

The Make Predictive Call service will originate a call between two devices by first creating a connection to the called device. The service returns a positive acknowledgement that provides the connection at the called device.

Subsequent actions are taken depending upon the call progress and the actions requested. Examples are:

• An attempt is made to connect at the calling device because a connected state was determined at the called device.
• The call was cleared because a connected state was determined at the called device and the switching function detected a FAX and was instructed by the computing function to clear the call in this case.

For an illustration of this event, see ECMA 269, section 17.1.19, Figure 17-22 "Make Predictive Call Service".

Connection State Transitions:

• The calling device's connection will transition from an allowable initial state of Null to one of the allowable final states of Initiated or Null.
• The called device's (initiated) connection will transition from an allowable initial states of Null to one of the allowable final states of Alerting, Connected, Failed, Queued, or Null.

See ECMA 269, section 17.1.19.3.2, for the following table describing the sequence of events for device-type monitoring. Table 17-106 "Make Predictive Call - Device-Type Monitoring Event Sequences"

See ECMA 269, section 17.1.19.3.3, for the following tables describing the sequence of events for call-type monitoring. Table 17-107 "Make Predictive Call - Call-Type Monitoring Event Sequences"

CSTA Functional Requirements:

1. The service does not guarantee the connection to the calling device; only that an attempt will be made to connect to the device.
2. The calling device in a Make Predictive Call service request is often a group or ACD device that then allocates the new call to another calling device.
3. A typical use of the Make Predictive Call service is to place calls outside the CSTA switching sub-domain. The CSTA connection identifier reported in the positive acknowledgement refers to the Network Interface Device associated with the called device.
4. The parameter defaultAction is used in situations where the switching function detects that the signallingCondition in the service request cannot be met. For example, the requestor of the service has the capability to instruct the switching function to either connect the calling device for listening to the voice channel or to clear the call.
5. If the validation of the Make Predictive Call fails initial for any reason, the computing function receives a negative acknowledgement, and no valid ConnectionIDs will have been created.
6. If the autoOriginate parameter is supported by the switching function and has a value of "attempt", and if the calling device is not capable of automatically answering the device, then the processing of this parameter is switching function dependent.
7. Call Forwarding and Do Not Disturb features for the calling device are not honoured for the call being made. If a switching function determines that it will not be able to deliver the call to the calling device (due to an active feature that cannot be overridden), then the switching function will return a negative acknowledgement before the call is launched to the called device.
8. All active features are honoured for the called device.
9. Multi-stage dialling is not supported for the Make Predictive Call service.
10. The switching function may indicate that the calling device is involved with a predictive call prior to any call activity at the calling device by generating a ServiceInitiatedEvent (with a cause of Make Predictive Call) for the calling device. When the Service Initiated event is generated in this case, it is generated prior to any call control events at the called device. If the switching function does not generate the Service Initiated event in this case, no call control events will be generated for the calling device until after the calling device is joined into the call. If the calling device cannot be joined in the call, a Connection Cleared event is generated for the initiatedConnection.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

MakePredictiveCall()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
byte[]	getAccountCode() Returns the value of field 'accountCode'.
java.lang.Long	getAlertTime() Returns the value of field 'alertTime'.
byte[]	getAuthCode() Returns the value of field 'authCode'.
AutoOriginate	getAutoOriginate() Returns the value of field 'autoOriginate'.
CallCharacteristics	getCallCharacteristics() Returns the value of field 'callCharacteristics'.
DeviceID	getCalledDirectoryNumber() Returns the value of field 'calledDirectoryNumber'.
DeviceID	getCallingDevice() Returns the value of field 'callingDevice'.
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
DetectionAction	getDefaultAction() Returns the value of field 'defaultAction'.
DestinationDetection	getDestinationDetection() Returns the value of field 'destinationDetection'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getLanguagePreferences() Returns the value of field 'languagePreferences'.
SignallingDetection	getSignallingDetection() Returns the value of field 'signallingDetection'.
java.lang.String	getSubjectOfCall() Returns the value of field 'subjectOfCall'.
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	setAccountCode(byte[] accountCode) Sets the value of field 'accountCode'.
void	setAlertTime(java.lang.Long alertTime) Sets the value of field 'alertTime'.
void	setAuthCode(byte[] authCode) Sets the value of field 'authCode'.
void	setAutoOriginate(AutoOriginate autoOriginate) Sets the value of field 'autoOriginate'.
void	setCallCharacteristics(CallCharacteristics callCharacteristics) Sets the value of field 'callCharacteristics'.
void	setCalledDirectoryNumber(DeviceID calledDirectoryNumber) Sets the value of field 'calledDirectoryNumber'.
void	setCallingDevice(DeviceID callingDevice) Sets the value of field 'callingDevice'.
void	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setDefaultAction(DetectionAction defaultAction) Sets the value of field 'defaultAction'.
void	setDestinationDetection(DestinationDetection destinationDetection) Sets the value of field 'destinationDetection'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setLanguagePreferences(java.lang.String languagePreferences) Sets the value of field 'languagePreferences'.
void	setSignallingDetection(SignallingDetection signallingDetection) Sets the value of field 'signallingDetection'.
void	setSubjectOfCall(java.lang.String subjectOfCall) Sets the value of field 'subjectOfCall'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static MakePredictiveCall	unmarshalMakePredictiveCall(java.io.Reader reader) Method unmarshalMakePredictiveCall
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

MakePredictiveCall

public MakePredictiveCall()

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

getAccountCode

public byte[] getAccountCode()

Returns the value of field 'accountCode'.

Returns:

byte

getAlertTime

public java.lang.Long getAlertTime()

Returns the value of field 'alertTime'. The field 'alertTime' has the following description: Specifies the amount of time, in seconds, the called device is to be alerted before the call is cleared. Optional.

Returns:

Long

getAuthCode

public byte[] getAuthCode()

Returns the value of field 'authCode'.

Returns:

byte

getAutoOriginate

public AutoOriginate getAutoOriginate()

Returns the value of field 'autoOriginate'. The field 'autoOriginate' has the following description: Specifies if the calling device's connection is automatically answered (hands-free mode). Optional.

The complete set of possible values is:

• prompt (default)
• doNotPrompt (auto originate)

Returns:

AutoOriginate

getCallCharacteristics

public CallCharacteristics getCallCharacteristics()

Returns the value of field 'callCharacteristics'.

Returns:

CallCharacteristics

getCalledDirectoryNumber

public DeviceID getCalledDirectoryNumber()

Returns the value of field 'calledDirectoryNumber'. The field 'calledDirectoryNumber' has the following description: Specifies the called device. Mandatory.

Returns:

DeviceID

getCallingDevice

public DeviceID getCallingDevice()

Returns the value of field 'callingDevice'. The field 'callingDevice' has the following description: Specifies the device on behalf of which the call is originated. Mandatory.

Returns:

DeviceID

getCorrelatorData

public CorrelatorData getCorrelatorData()

Returns the value of field 'correlatorData'.

Returns:

CorrelatorData

getDefaultAction

public DetectionAction getDefaultAction()

Returns the value of field 'defaultAction'. The field 'defaultAction' has the following description: Specifies the actions to be taken when the switching function determines that the condition specified in the signallingCondition component cannot be met. Optional.

The complete list of possible values is:

• clearCalledConnection - The connection for the called device is to be cleared.
• remainConnected - The called device is to remain in the call and the connection to the calling device is attempted.

Returns:

DetectionAction

getDestinationDetection

public DestinationDetection getDestinationDetection()

Returns the value of field 'destinationDetection'. The field 'destinationDetection' has the following description: Specifies the switching function actions to be taken when the specified signallingCondition at the called device is met. Optional.

Each entry in the list contains the following:

• destinationCondition (M) Enumerated - Specifies the condition that must be satisfied before the switching function processes the detectionAction. The complete set of possible values is:
  • humanVoice - Process the specified actions when a human voice is detected at the called device.
  • answeringMachine - Process the specified actions when an answering machine is detected at the called device.
  • facsimileMachine - Process the specified actions when a (FAX) machine or modem is detected at the called device.
• detectionAction (M) Enumerated - Action to be taken by the switching function upon detecting of a particular destination condition. The complete set of possible values is:
  • clearCalledConnection - The connection for the called device is to be cleared.
  • remainConnected - The called device is to remain in the call and the connection to the calling device is attempted.

Note that if multiple entries are provided, the switching function will process the detectionAction associated with the first destinationCondition that is detected.

Returns:

DestinationDetection

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

getSignallingDetection

public SignallingDetection getSignallingDetection()

Returns the value of field 'signallingDetection'. The field 'signallingDetection' has the following description: Specifies the switching function actions to be taken when the specified call progress conditions at the called device or network are met. Optional.

It includes the following components:

• signallingCondition (M) Enumerated - Specifies the conditions that must be satisfied before the switching function processes the signallingConditionsAction. The complete set of possible values is:
  • callDelivered - Process the specified actions when the call is delivered to or answered at the called device (whichever occurs first).
  • callEstablished - Process the specified actions when the call has been answered at the called device.
• signallingConditionsAction (M) Enumerated - Action to be taken by the switching function upon detecting a signallingCondition. The complete set of possible values is:
  • destinationDetection - The conditions/actions specified in the destinationDetection parameter should be followed.
  • remainConnected - The called device is to remain in the call and the connection to the calling device is attempted.

Returns:

SignallingDetection

getSubjectOfCall

public java.lang.String getSubjectOfCall()

Returns the value of field 'subjectOfCall'.

Returns:

String

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

setAccountCode

public void setAccountCode(byte[] accountCode)

Sets the value of field 'accountCode'.

Parameters:

accountCode - the value of field 'accountCode'.

setAlertTime

public void setAlertTime(java.lang.Long alertTime)

Sets the value of field 'alertTime'. The field 'alertTime' has the following description: Specifies the amount of time, in seconds, the called device is to be alerted before the call is cleared. Optional.

Parameters:

alertTime - the value of field 'alertTime'.

setAuthCode

public void setAuthCode(byte[] authCode)

Sets the value of field 'authCode'.

Parameters:

authCode - the value of field 'authCode'.

setAutoOriginate

public void setAutoOriginate(AutoOriginate autoOriginate)

Sets the value of field 'autoOriginate'. The field 'autoOriginate' has the following description: Specifies if the calling device's connection is automatically answered (hands-free mode). Optional.

The complete set of possible values is:

• prompt (default)
• doNotPrompt (auto originate)

Parameters:

autoOriginate - the value of field 'autoOriginate'.

setCallCharacteristics

public void setCallCharacteristics(CallCharacteristics callCharacteristics)

Sets the value of field 'callCharacteristics'.

Parameters:

callCharacteristics - the value of field 'callCharacteristics'.

setCalledDirectoryNumber

public void setCalledDirectoryNumber(DeviceID calledDirectoryNumber)

Sets the value of field 'calledDirectoryNumber'. The field 'calledDirectoryNumber' has the following description: Specifies the called device. Mandatory.

Parameters:

calledDirectoryNumber - the value of field 'calledDirectoryNumber'.

setCallingDevice

public void setCallingDevice(DeviceID callingDevice)

Sets the value of field 'callingDevice'. The field 'callingDevice' has the following description: Specifies the device on behalf of which the call is originated. Mandatory.

Parameters:

callingDevice - the value of field 'callingDevice'.

setCorrelatorData

public void setCorrelatorData(CorrelatorData correlatorData)

Sets the value of field 'correlatorData'.

Parameters:

correlatorData - the value of field 'correlatorData'.

setDefaultAction

public void setDefaultAction(DetectionAction defaultAction)

Sets the value of field 'defaultAction'. The field 'defaultAction' has the following description: Specifies the actions to be taken when the switching function determines that the condition specified in the signallingCondition component cannot be met. Optional.

The complete list of possible values is:

• clearCalledConnection - The connection for the called device is to be cleared.
• remainConnected - The called device is to remain in the call and the connection to the calling device is attempted.

Parameters:

defaultAction - the value of field 'defaultAction'.

setDestinationDetection

public void setDestinationDetection(DestinationDetection destinationDetection)

Sets the value of field 'destinationDetection'. The field 'destinationDetection' has the following description: Specifies the switching function actions to be taken when the specified signallingCondition at the called device is met. Optional.

Each entry in the list contains the following:

• destinationCondition (M) Enumerated - Specifies the condition that must be satisfied before the switching function processes the detectionAction. The complete set of possible values is:
  • humanVoice - Process the specified actions when a human voice is detected at the called device.
  • answeringMachine - Process the specified actions when an answering machine is detected at the called device.
  • facsimileMachine - Process the specified actions when a (FAX) machine or modem is detected at the called device.
• detectionAction (M) Enumerated - Action to be taken by the switching function upon detecting of a particular destination condition. The complete set of possible values is:
  • clearCalledConnection - The connection for the called device is to be cleared.
  • remainConnected - The called device is to remain in the call and the connection to the calling device is attempted.

Note that if multiple entries are provided, the switching function will process the detectionAction associated with the first destinationCondition that is detected.

Parameters:

destinationDetection - the value of field 'destinationDetection'.

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

setSignallingDetection

public void setSignallingDetection(SignallingDetection signallingDetection)

Sets the value of field 'signallingDetection'. The field 'signallingDetection' has the following description: Specifies the switching function actions to be taken when the specified call progress conditions at the called device or network are met. Optional.

It includes the following components:

• signallingCondition (M) Enumerated - Specifies the conditions that must be satisfied before the switching function processes the signallingConditionsAction. The complete set of possible values is:
  • callDelivered - Process the specified actions when the call is delivered to or answered at the called device (whichever occurs first).
  • callEstablished - Process the specified actions when the call has been answered at the called device.
• signallingConditionsAction (M) Enumerated - Action to be taken by the switching function upon detecting a signallingCondition. The complete set of possible values is:
  • destinationDetection - The conditions/actions specified in the destinationDetection parameter should be followed.
  • remainConnected - The called device is to remain in the call and the connection to the calling device is attempted.

Parameters:

signallingDetection - the value of field 'signallingDetection'.

setSubjectOfCall

public void setSubjectOfCall(java.lang.String subjectOfCall)

Sets the value of field 'subjectOfCall'.

Parameters:

subjectOfCall - the value of field 'subjectOfCall'.

setUserData

public void setUserData(UserData userData)

Sets the value of field 'userData'.

Parameters:

userData - the value of field 'userData'.

unmarshalMakePredictiveCall

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

Method unmarshalMakePredictiveCall

Parameters:

reader -

Returns:

MakePredictiveCall

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