ch.ecma.csta.binding
Class StartDataCollection

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

All Implemented Interfaces:

java.io.Serializable

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

This request has been deprecated.

Starts data collection on a connection. Used to collect information such as DTMF/rotary pulse digits and telephony tones from a connection at a specified device.

Data Collection may be started on either an existing connection or on the first connection that appears at a device after the service request has been acknowledged.

Data Collection continues until the StopDataCollection service is used to terminate the collection or until the connection over which data is being collected is cleared. This connection is either an existing connection or the first connection that appears at a device after the service request has been acknowledged.

The service request specifies criteria that specify when the collection of DTMF/rotary pulse digits is reported via the DataCollected service.

CSTA Functional Requirements:

1. The Start Data Collection service collects information (for example, DTMF digits, telephony tones) that is received over a connection at a device (that is, information that has been sent over a connection from another device in the call).
2. The Data Collected service is used to report the collected information. When DTMF/rotary pulse digits are being collected, it is sent when one of the reporting criteria, as specified in the digitsReportingCriteria parameter, is satisfied. When telephony tones are being collected, the Data Collected service is sent after a single telephony tone is collected.
3. The purpose of the Start Data Collection service is to detect digits and tones sent to the specified device. However, it cannot be presumed that the source of the digits and tones can be determined by the collection device in every situation (for example, analog lines).
4. If the digitsReportingCriteria is not provided, the number of digits (for digits collection) that need to be detected before the Data Collected service is generated is switching function specific.
5. For telephonyTones collection, the detected tone is reported via the Data Collected service as soon as the switching function has recognized the tone.
6. If the switching function receives a subsequent request for this service with the object parameter specified as call (connection), and data collection has already started due to a previous Start Data Collection service, the switching function will respond with a negative acknowledgement specifying an error code of "Feature Already Set".

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

StartDataCollection()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
DataCollType	getDataCollType() Returns the value of field 'dataCollType'.
DigitsReportingCriteria	getDigitsReportingCriteria() Returns the value of field 'digitsReportingCriteria'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
CallObject	getObject() Returns the value of field 'object'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setDataCollType(DataCollType dataCollType) Sets the value of field 'dataCollType'.
void	setDigitsReportingCriteria(DigitsReportingCriteria digitsReportingCriteria) Sets the value of field 'digitsReportingCriteria'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setObject(CallObject object) Sets the value of field 'object'.
static StartDataCollection	unmarshalStartDataCollection(java.io.Reader reader) Method unmarshalStartDataCollection
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

StartDataCollection

public StartDataCollection()

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

getDataCollType

public DataCollType getDataCollType()

Returns the value of field 'dataCollType'. The field 'dataCollType' has the following description: Specifies the data-type of the data collection. Optional.

The complete set of possible values is:

• digits - DTMF/rotary pulse digits
• telephonyTones - telephony tones

Returns:

DataCollType

getDigitsReportingCriteria

public DigitsReportingCriteria getDigitsReportingCriteria()

Returns the value of field 'digitsReportingCriteria'. The field 'digitsReportingCriteria' has the following description: Specifies the criteria associated with the reporting of the DTMF/rotary pulse digits. This value may be provided only when the dataCollType value is Digits. Optional.

This parameter consists of the following components:

• numChars (C) Value - specifies the number of characters to collect before sending the Data Collected message with the collected digit characters.
• flushChar (C) Character(1) - specifies an ASCII (IA5) character that, if detected, causes any previously unreported digit characters (including this character) to be sent in the Data Collected service.
• timeout (C) Value - specifies a duration, in milliseconds, when any previously unreported digit characters are sent in the Data Collected service.

If this parameter is provided, at least one component must be provided.

Returns:

DigitsReportingCriteria

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getObject

public CallObject getObject()

Returns the value of field 'object'. The field 'object' has the following description: Specifies the object to which a data collection should be initiated. Mandatory.

This will be one of the following choices:

• device (DeviceID) - specifies the device upon which the data collection is to be started. Data collection occurs on the next connection at this device and is stopped when this connection is cleared. If there are one or more calls at this device and this choice is selected, then this service request will be rejected.
• call (ConnectionID) - specifies a specific call (connection) upon which the data collection is to be started.

Returns:

CallObject

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

setDataCollType

public void setDataCollType(DataCollType dataCollType)

Sets the value of field 'dataCollType'. The field 'dataCollType' has the following description: Specifies the data-type of the data collection. Optional.

The complete set of possible values is:

• digits - DTMF/rotary pulse digits
• telephonyTones - telephony tones

Parameters:

dataCollType - the value of field 'dataCollType'.

setDigitsReportingCriteria

public void setDigitsReportingCriteria(DigitsReportingCriteria digitsReportingCriteria)

Sets the value of field 'digitsReportingCriteria'. The field 'digitsReportingCriteria' has the following description: Specifies the criteria associated with the reporting of the DTMF/rotary pulse digits. This value may be provided only when the dataCollType value is Digits. Optional.

This parameter consists of the following components:

• numChars (C) Value - specifies the number of characters to collect before sending the Data Collected message with the collected digit characters.
• flushChar (C) Character(1) - specifies an ASCII (IA5) character that, if detected, causes any previously unreported digit characters (including this character) to be sent in the Data Collected service.
• timeout (C) Value - specifies a duration, in milliseconds, when any previously unreported digit characters are sent in the Data Collected service.

If this parameter is provided, at least one component must be provided.

Parameters:

digitsReportingCriteria - the value of field 'digitsReportingCriteria'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setObject

public void setObject(CallObject object)

Sets the value of field 'object'. The field 'object' has the following description: Specifies the object to which a data collection should be initiated. Mandatory.

This will be one of the following choices:

• device (DeviceID) - specifies the device upon which the data collection is to be started. Data collection occurs on the next connection at this device and is stopped when this connection is cleared. If there are one or more calls at this device and this choice is selected, then this service request will be rejected.
• call (ConnectionID) - specifies a specific call (connection) upon which the data collection is to be started.

Parameters:

object - the value of field 'object'.

unmarshalStartDataCollection

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

Method unmarshalStartDataCollection

Parameters:

reader -

Returns:

StartDataCollection

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