ch.ecma.csta.binding
Class DigitsDialedEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Not implemented.

Indicates that a call or feature is being attempted from a device and that a portion of the dialling sequence has been completed. It implies that only part of the input activity is complete, and that more of the dialling sequence needs to be supplied before the entire input activity is complete.

After the entire dialling sequence is complete, the OriginatedEvent will be generated in the case where a call is being attempted. The last Digits Dialled event received prior to receiving the Originated event will report the last digits dialled to complete the dialling sequence.

For an illustration of this event, see ECMA 269, section 17.2.6, Figure 17-38 "Digits Dialled Event".

The Digits Dialed Event could be caused by any of the following:

• Digits were dialled as part of a consultation for the purpose of a conference.
• Digits were dialled as part of a consultation.
• Digits were dialled after a call has left the switching sub-domain.
• Digits were dialled (a more specific event cause cannot be provided).
• Digits were dialled as part of a consultation for the purpose of a transfer.

CSTA Functional Requirements:

1. This event will only be generated when the computing function has a device-type or call-type monitoring applied to a device that is initiating a call.
2. The grouping and number of digits reported in each event is switching function dependent.
3. The first Digits Dialled event includes the first digit specified in the MakeCall or ConsultationCall service which started the dialling sequence. If no digits were specified in the initiating Make Call or Consultation Call service (in the case where a null string was passed in the service request), the diallingSequence parameter in the Digits Dialled event contains a null string.
4. The digit sequence reported by the sequence of Digits Dialled events reflects the digits actually dialled through manual interaction or by CSTA service requests. It will not reflect any filtering or manipulation of the digit sequence by the switching function.
5. If a NetworkReachedEvent is received prior to the receipt of an originated event, it may not be possible to determine the complete dialling sequence.
6. The switching function may have a timeout period for multi-stage dialling. If the dialling sequence does not complete prior to this timeout, it may either abort the call or attempt to use the digits already dialled and signal that dialling is complete with an originated event.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

DigitsDialedEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
AssociatedCalledDeviceID	getAssociatedCalledDevice() Returns the value of field 'associatedCalledDevice'.
AssociatedCallingDeviceID	getAssociatedCallingDevice() Returns the value of field 'associatedCallingDevice'.
CallCharacteristics	getCallCharacteristics() Returns the value of field 'callCharacteristics'.
CallLinkageData	getCallLinkageData() Returns the value of field 'callLinkageData'.
EventCause	getCause() Returns the value of field 'cause'.
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
ConnectionID	getDialingConnection() Returns the value of field 'dialingConnection'.
ConnectionInformation	getDialingConnectionInfo() Returns the value of field 'dialingConnectionInfo'.
SubjectDeviceID	getDialingDevice() Returns the value of field 'dialingDevice'.
DeviceID	getDialingSequence() Returns the value of field 'dialingSequence'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getLanguagePreferences() Returns the value of field 'languagePreferences'.
LocalConnectionState	getLocalConnectionInfo() Returns the value of field 'localConnectionInfo'.
java.lang.String	getMonitorCrossRefID() Returns the value of field 'monitorCrossRefID'.
NetworkCalledDeviceID	getNetworkCalledDevice() Returns the value of field 'networkCalledDevice'.
NetworkCallingDeviceID	getNetworkCallingDevice() Returns the value of field 'networkCallingDevice'.
ServicesPermitted	getServicesPermitted() Returns the value of field 'servicesPermitted'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setAssociatedCalledDevice(AssociatedCalledDeviceID associatedCalledDevice) Sets the value of field 'associatedCalledDevice'.
void	setAssociatedCallingDevice(AssociatedCallingDeviceID associatedCallingDevice) Sets the value of field 'associatedCallingDevice'.
void	setCallCharacteristics(CallCharacteristics callCharacteristics) Sets the value of field 'callCharacteristics'.
void	setCallLinkageData(CallLinkageData callLinkageData) Sets the value of field 'callLinkageData'.
void	setCause(EventCause cause) Sets the value of field 'cause'.
void	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setDialingConnection(ConnectionID dialingConnection) Sets the value of field 'dialingConnection'.
void	setDialingConnectionInfo(ConnectionInformation dialingConnectionInfo) Sets the value of field 'dialingConnectionInfo'.
void	setDialingDevice(SubjectDeviceID dialingDevice) Sets the value of field 'dialingDevice'.
void	setDialingSequence(DeviceID dialingSequence) Sets the value of field 'dialingSequence'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setLanguagePreferences(java.lang.String languagePreferences) Sets the value of field 'languagePreferences'.
void	setLocalConnectionInfo(LocalConnectionState localConnectionInfo) Sets the value of field 'localConnectionInfo'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
void	setNetworkCalledDevice(NetworkCalledDeviceID networkCalledDevice) Sets the value of field 'networkCalledDevice'.
void	setNetworkCallingDevice(NetworkCallingDeviceID networkCallingDevice) Sets the value of field 'networkCallingDevice'.
void	setServicesPermitted(ServicesPermitted servicesPermitted) Sets the value of field 'servicesPermitted'.
static DigitsDialedEvent	unmarshalDigitsDialedEvent(java.io.Reader reader) Method unmarshalDigitsDialedEvent
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

DigitsDialedEvent

public DigitsDialedEvent()

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

getAssociatedCalledDevice

public AssociatedCalledDeviceID getAssociatedCalledDevice()

Returns the value of field 'associatedCalledDevice'.

Returns:

AssociatedCalledDeviceID

getAssociatedCallingDevice

public AssociatedCallingDeviceID getAssociatedCallingDevice()

Returns the value of field 'associatedCallingDevice'.

Returns:

AssociatedCallingDeviceID

getCallCharacteristics

public CallCharacteristics getCallCharacteristics()

Returns the value of field 'callCharacteristics'.

Returns:

CallCharacteristics

getCallLinkageData

public CallLinkageData getCallLinkageData()

Returns the value of field 'callLinkageData'.

Returns:

CallLinkageData

getCause

public EventCause getCause()

Returns the value of field 'cause'.

Returns:

EventCause

getCorrelatorData

public CorrelatorData getCorrelatorData()

Returns the value of field 'correlatorData'.

Returns:

CorrelatorData

getDialingConnection

public ConnectionID getDialingConnection()

Returns the value of field 'dialingConnection'. The field 'dialingConnection' has the following description: Specifies the connection at which the digits were dialled. Mandatory.

Returns:

ConnectionID

getDialingConnectionInfo

public ConnectionInformation getDialingConnectionInfo()

Returns the value of field 'dialingConnectionInfo'. The field 'dialingConnectionInfo' has the following description: Specifies the connection information associated with the diallingConnection connection. Optional. If this parameter is not present, then the connection information is switching function specific.

Returns:

ConnectionInformation

getDialingDevice

public SubjectDeviceID getDialingDevice()

Returns the value of field 'dialingDevice'. The field 'dialingDevice' has the following description: Specifies the device at which the digits were dialled. Mandatory.

Returns:

SubjectDeviceID

getDialingSequence

public DeviceID getDialingSequence()

Returns the value of field 'dialingSequence'. The field 'dialingSequence' has the following description: Specifies the sequence of digits that was dialled. Mandatory.

Returns:

DeviceID

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

getLocalConnectionInfo

public LocalConnectionState getLocalConnectionInfo()

Returns the value of field 'localConnectionInfo'.

Returns:

LocalConnectionState

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()

Returns the value of field 'monitorCrossRefID'.

Returns:

String

getNetworkCalledDevice

public NetworkCalledDeviceID getNetworkCalledDevice()

Returns the value of field 'networkCalledDevice'.

Returns:

NetworkCalledDeviceID

getNetworkCallingDevice

public NetworkCallingDeviceID getNetworkCallingDevice()

Returns the value of field 'networkCallingDevice'.

Returns:

NetworkCallingDeviceID

getServicesPermitted

public ServicesPermitted getServicesPermitted()

Returns the value of field 'servicesPermitted'.

Returns:

ServicesPermitted

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

setAssociatedCalledDevice

public void setAssociatedCalledDevice(AssociatedCalledDeviceID associatedCalledDevice)

Sets the value of field 'associatedCalledDevice'.

Parameters:

associatedCalledDevice - the value of field 'associatedCalledDevice'.

setAssociatedCallingDevice

public void setAssociatedCallingDevice(AssociatedCallingDeviceID associatedCallingDevice)

Sets the value of field 'associatedCallingDevice'.

Parameters:

associatedCallingDevice - the value of field 'associatedCallingDevice'.

setCallCharacteristics

public void setCallCharacteristics(CallCharacteristics callCharacteristics)

Sets the value of field 'callCharacteristics'.

Parameters:

callCharacteristics - the value of field 'callCharacteristics'.

setCallLinkageData

public void setCallLinkageData(CallLinkageData callLinkageData)

Sets the value of field 'callLinkageData'.

Parameters:

callLinkageData - the value of field 'callLinkageData'.

setCause

public void setCause(EventCause cause)

Sets the value of field 'cause'.

Parameters:

cause - the value of field 'cause'.

setCorrelatorData

public void setCorrelatorData(CorrelatorData correlatorData)

Sets the value of field 'correlatorData'.

Parameters:

correlatorData - the value of field 'correlatorData'.

setDialingConnection

public void setDialingConnection(ConnectionID dialingConnection)

Sets the value of field 'dialingConnection'. The field 'dialingConnection' has the following description: Specifies the connection at which the digits were dialled. Mandatory.

Parameters:

dialingConnection - the value of field 'dialingConnection'.

setDialingConnectionInfo

public void setDialingConnectionInfo(ConnectionInformation dialingConnectionInfo)

Sets the value of field 'dialingConnectionInfo'. The field 'dialingConnectionInfo' has the following description: Specifies the connection information associated with the diallingConnection connection. Optional. If this parameter is not present, then the connection information is switching function specific.

Parameters:

dialingConnectionInfo - the value of field 'dialingConnectionInfo'.

setDialingDevice

public void setDialingDevice(SubjectDeviceID dialingDevice)

Sets the value of field 'dialingDevice'. The field 'dialingDevice' has the following description: Specifies the device at which the digits were dialled. Mandatory.

Parameters:

dialingDevice - the value of field 'dialingDevice'.

setDialingSequence

public void setDialingSequence(DeviceID dialingSequence)

Sets the value of field 'dialingSequence'. The field 'dialingSequence' has the following description: Specifies the sequence of digits that was dialled. Mandatory.

Parameters:

dialingSequence - the value of field 'dialingSequence'.

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

setLocalConnectionInfo

public void setLocalConnectionInfo(LocalConnectionState localConnectionInfo)

Sets the value of field 'localConnectionInfo'.

Parameters:

localConnectionInfo - the value of field 'localConnectionInfo'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

setNetworkCalledDevice

public void setNetworkCalledDevice(NetworkCalledDeviceID networkCalledDevice)

Sets the value of field 'networkCalledDevice'.

Parameters:

networkCalledDevice - the value of field 'networkCalledDevice'.

setNetworkCallingDevice

public void setNetworkCallingDevice(NetworkCallingDeviceID networkCallingDevice)

Sets the value of field 'networkCallingDevice'.

Parameters:

networkCallingDevice - the value of field 'networkCallingDevice'.

setServicesPermitted

public void setServicesPermitted(ServicesPermitted servicesPermitted)

Sets the value of field 'servicesPermitted'.

Parameters:

servicesPermitted - the value of field 'servicesPermitted'.

unmarshalDigitsDialedEvent

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

Method unmarshalDigitsDialedEvent

Parameters:

reader -

Returns:

DigitsDialedEvent

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