ch.ecma.csta.binding
Class DialDigits

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

All Implemented Interfaces:

java.io.Serializable

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

This request is not supported.

Dials a digit sequence for a call that has already been initiated. Allows the computing function to perform a dialling sequence that is associated with a call that has already been initiated (that is, has manually gone off-hook or has been initiated via a MakeCall or ConsultationCall service). This service is also used to perform the dialling sequences associated with completing a multi-stage dialled call.

For an illustration of this event, see ECMA 269, section 17.1.12, Figure 17-13 "Dial Digits Service".

See Connection Failure for a complete description of "Call ID only" connection IDs.

Connection State Transitions:

• The dialling connection will transition from an allowable initial state of Initiated to one of the allowable final states of Initiated or Connected. Note: (The connected state only applies to external outbound calls. It indicates that enough of the dial string has been communicated for the switching function to connect the call to the network interface device that will be associated with the called device in the external network.)
• The called connection will transition from one of the allowable initial states of Null or Connected to one of the allowable final states of Alerting, Connected, Failed, Queued, or Null (Null if call moves away from D3 (that is, forwarded).

See ECMA 269, section 17.1.12.3.2, Table 17-66 "Dial Digits - Device-Type Monitoring Event Sequences" for a table describing the sequence of events for device-type monitoring.

See ECMA 269, section 17.1.12.3.3, Table 17-67 "Dial Digits - Call-Type Monitoring Event Sequences" for a table describing the sequence of events for call-type monitoring.

CSTA Functional Requirements:

1. The Dial Digits service only effects the diallingConnection call. If other calls exist at the diallingConnection Connection ID's device, they remain unaffected.
2. This service can not be used to generate DTMF tones on an existing connected call. The Generate Digits service is used for this. This service is only used to perform the dialling sequences for placing a call (that is, outbound dialling).
3. If no digits have been dialled for the diallingConnection through the original MakeCall service or a previous Dial Digits service, the diallingSequence parameter can be any format of device identifier. Otherwise the diallingSequence parameter will be in Diallable Digits format.
4. If the diallingSequence parameter is intended to provide just a portion of a longer dialling sequence to follow, then it will be in Diallable Digits format with the last character of the sequence being ";". Otherwise the diallingSequence parameter will be interpreted as the last in the dialling sequence for the diallingConnection.
5. The premature termination of a dialling sequence can be done by either using the ClearConnection service, ClearCall service, or having the dialling connection manually cleared.
6. The switching function may have a time-out 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.
7. If the switching function determines that dialling is complete even if a ";"was supplied, it will originate the call and ignore any subsequent digits.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

DialDigits()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
ConnectionID	getDiallingConnection() Returns the value of field 'diallingConnection'.
DeviceID	getDiallingSequence() Returns the value of field 'diallingSequence'.
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	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setDiallingConnection(ConnectionID diallingConnection) Sets the value of field 'diallingConnection'.
void	setDiallingSequence(DeviceID diallingSequence) Sets the value of field 'diallingSequence'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
static DialDigits	unmarshalDialDigits(java.io.Reader reader) Method unmarshalDialDigits
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

DialDigits

public DialDigits()

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

getCorrelatorData

public CorrelatorData getCorrelatorData()

Returns the value of field 'correlatorData'.

Returns:

CorrelatorData

getDiallingConnection

public ConnectionID getDiallingConnection()

Returns the value of field 'diallingConnection'. The field 'diallingConnection' has the following description: Specifies the connection which is dialling the digits. Mandatory.

Returns:

ConnectionID

getDiallingSequence

public DeviceID getDiallingSequence()

Returns the value of field 'diallingSequence'. The field 'diallingSequence' has the following description: Specifies the actual string of digits to be dialled. Mandatory. To specify a partial dialling sequence, the Diallable Digits format (DD) of the DeviceID with the ";" character as the last digit in the string will be used.

Returns:

DeviceID

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

setCorrelatorData

public void setCorrelatorData(CorrelatorData correlatorData)

Sets the value of field 'correlatorData'.

Parameters:

correlatorData - the value of field 'correlatorData'.

setDiallingConnection

public void setDiallingConnection(ConnectionID diallingConnection)

Sets the value of field 'diallingConnection'. The field 'diallingConnection' has the following description: Specifies the connection which is dialling the digits. Mandatory.

Parameters:

diallingConnection - the value of field 'diallingConnection'.

setDiallingSequence

public void setDiallingSequence(DeviceID diallingSequence)

Sets the value of field 'diallingSequence'. The field 'diallingSequence' has the following description: Specifies the actual string of digits to be dialled. Mandatory. To specify a partial dialling sequence, the Diallable Digits format (DD) of the DeviceID with the ";" character as the last digit in the string will be used.

Parameters:

diallingSequence - the value of field 'diallingSequence'

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

unmarshalDialDigits

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

Method unmarshalDialDigits

Parameters:

reader -

Returns:

DialDigits

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