ch.ecma.csta.binding
Class MakeCall

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

All Implemented Interfaces:

java.io.Serializable

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

Establishes a call between a calling device and a called device.

The service creates a new call and establishes an initiated or connected connection with the calling device. The Make Call service assigns a ConnectionID to the calling device and returns it in the positive acknowledgement.

Connection State Transitions:

• Case A: Complete Dialling Sequence
  • The callingDevice connection will transition from one of the allowable initial states of Null or Initiated to one of the allowable final states of Initiated or Connected. See notes.
  • The called connection will transition from an allowable initial state of Null to one of the allowable final states of Alerting, Connected, Queued, Fail, or Null. (Null if call moves away from the originally called device [that is, forwarded]).
• Case B: Partial Dialling Sequence
  • Not supported.

The MakeCall request has these parameters:

MakeCall Request Parameters
callingDevice	Mandatory	Valid station extension or AWOH station extension.
calledDirectoryNumber	Mandatory	Valid on-PBX extension or off PBX number

CSTA Functional Requirements:

1. Prompting of the calling device during the processing of the Make Call service is switching function specific (display flashing, ring pattern, lamp blinking, etc.).
2. If the validation of the Make Call service fails for any reason, the computing function receives a negative acknowledgement, and no valid ConnectionIDs will have been created.
3. If the autoOriginate parameter is supported by the switching function and has a value of "Do Not Prompt", and if the calling device is not capable of automatically answering the device, then the processing of this parameter is switching function dependent.
4. Call Forwarding and Do Not Disturb features for the calling device are not honoured for the call being made. If a switching function supports prompting of the calling device and detects that a feature was activated while processing the Make Call service and this feature cannot be overridden, then the switching function will return a negative acknowledgement.
5. All active features are honoured for the called device.
6. If a Make Call service is issued for a calling device that has a connection in the Initiated state (that is, the computing function got a Service Initiated event for a phone manually going off-hook), and the switching function can support the issuing of the Make Call service under this condition, then the Connection ID in the positive acknowledgement of the Make Call service will contain the same Connection ID received on the Service Initiated event. If the switching function does not support the Make Call service under this condition, then the service will be rejected with a negative acknowledgement.
7. Not Supported as the callDirectoryNumber must contain a complete dial string. NULL or partial dial strings are not supported.
8. Not supported as it applies to multistage dialling.
9. When prompting a device which has a call appearance, bridged, or hybrid device configuration, only one of the appearances will be delivered the call.
10. Not supported as it applies to digital data.
11. Not supported as it applies to digital data.
12. The callingDevice parameter in the Make Call service request may represent a group of devices from which the actual calling device is selected. In this case, the callingDevice parameter in subsequent events will refer to the actual calling device. In addition, the Originated event contains a parameter (originatingDevice) that represents the group of devices (the callingDevice parameter passed in service request).

Negative Acknowledgements:

• stateIncompatibility:invalidCallingDeviceState - Sent if the originator does not go off-hook within five seconds after originating the call and cannot be forced off-hook.
• systemResourceAvailability:CallingDeviceOutOfService - Sent if the callingDevice is out of service or not administered correctly in the switch.
• operation:invalidCallingDeviceID - Sent if the Device ID or extension specified for the calling device is invalid.
• systemResourceAvailability:ResourceBusy - Sent if the user is busy on another call and cannot originate this call.
• operation:securityViolation - Sent if the user was not authorized to control the calling 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

MakeCall()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
byte[]	getAccountCode() Returns the value of field 'accountCode'.
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'.
ConnectionInformation	getCallingConnectionInfo() Returns the value of field 'callingConnectionInfo'.
DeviceID	getCallingDevice() Returns the value of field 'callingDevice'.
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getLanguagePreferences() Returns the value of field 'languagePreferences'.
MediaCallCharacteristics	getMediaCallCharacteristics() Returns the value of field 'mediaCallCharacteristics'.
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	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	setCallingConnectionInfo(ConnectionInformation callingConnectionInfo) Sets the value of field 'callingConnectionInfo'.
void	setCallingDevice(DeviceID callingDevice) Sets the value of field 'callingDevice'.
void	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setLanguagePreferences(java.lang.String languagePreferences) Sets the value of field 'languagePreferences'.
void	setMediaCallCharacteristics(MediaCallCharacteristics mediaCallCharacteristics) Sets the value of field 'mediaCallCharacteristics'.
void	setSubjectOfCall(java.lang.String subjectOfCall) Sets the value of field 'subjectOfCall'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static MakeCall	unmarshalMakeCall(java.io.Reader reader) Method unmarshalMakeCall
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

MakeCall

public MakeCall()

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

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)
• Do Not Prompt (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

getCallingConnectionInfo

public ConnectionInformation getCallingConnectionInfo()

Returns the value of field 'callingConnectionInfo'. The field 'callingConnectionInfo' has the following description: This specifies the connection information needed for the creation of a connection at the callingDevice. Optional. If this parameter is not present then the connection information is switching function specific.

Returns:

ConnectionInformation

getCallingDevice

public DeviceID getCallingDevice()

Returns the value of field 'callingDevice'. The field 'callingDevice' has the following description: Specifies the calling/originating device. Mandatory.

Note that this device may be a device that represents a group of devices. In this case the callingDevice in the service request is different from the actual calling device.

Returns:

DeviceID

getCorrelatorData

public CorrelatorData getCorrelatorData()

Returns the value of field 'correlatorData'.

Returns:

CorrelatorData

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

getMediaCallCharacteristics

public MediaCallCharacteristics getMediaCallCharacteristics()

Returns the value of field 'mediaCallCharacteristics'.

Returns:

MediaCallCharacteristics

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

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)
• Do Not Prompt (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'.

setCallingConnectionInfo

public void setCallingConnectionInfo(ConnectionInformation callingConnectionInfo)

Sets the value of field 'callingConnectionInfo'. The field 'callingConnectionInfo' has the following description: This specifies the connection information needed for the creation of a connection at the callingDevice. Optional. If this parameter is not present then the connection information is switching function specific.

Parameters:

callingConnectionInfo - the value of field 'callingConnectionInfo'.

setCallingDevice

public void setCallingDevice(DeviceID callingDevice)

Sets the value of field 'callingDevice'. The field 'callingDevice' has the following description: Specifies the calling/originating device. Mandatory.

Note that this device may be a device that represents a group of devices. In this case the callingDevice in the service request is different from the actual calling device.

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

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

setMediaCallCharacteristics

public void setMediaCallCharacteristics(MediaCallCharacteristics mediaCallCharacteristics)

Sets the value of field 'mediaCallCharacteristics'.

Parameters:

mediaCallCharacteristics - the value of field 'mediaCallCharacteristics'.

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

unmarshalMakeCall

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

Method unmarshalMakeCall

Parameters:

reader -

Returns:

MakeCall

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