4.1.0.610 20071213

ch.ecma.csta.binding
Class GenerateDigits

java.lang.Object
  extended by ch.ecma.csta.CastorObject
      extended by ch.ecma.csta.binding.GenerateDigits
All Implemented Interfaces:
java.io.Serializable

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

The GenerateDigits request has these parameters:

GenerateDigits Request Parameters
connectionToSendDigits Mandatory Connection of the device which is generating digits for the call.
charactersToSend Mandatory Specifies the string of characters to send.
toneDuration Optional Specifies the duration, in milliseconds, of each tone to be provided.

CSTA Functional Requirements:

  1. This service is used for end-to-end signalling purposes. This service shall not be used to perform dialling sequences (the Dial Digits service shall be used to perform this function).
  2. The charactersToSend parameter may contain additional non-standardised characters. Handling of the additional characters is switching function dependent.
  3. If the toneDuration or pulseRate parameters in the service request are not present or if they are present but cannot be satisfied, the switching function may use its default value.
  4. A Generate Digits service request may be rejected if there is already a switching function generated tone (busy, music, ringback, etc.) on the call.
  5. If a Generate Digits service request is received by the switching function while a previous Generate Digits service request has not yet been completed, the new request may or may not be rejected but in any case the digits shall not be interleaved or overlaid.

Negative Acknowledgements:

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
GenerateDigits()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
          Note: hashCode() has not been overriden
 java.lang.String getCharactersToSend()
          Returns the value of field 'charactersToSend'.
 ConnectionID getConnectionToSendDigits()
          Returns the value of field 'connectionToSendDigits'.
 DigitMode getDigitMode()
          Returns the value of field 'digitMode'.
 CSTACommonArguments getExtensions()
          Returns the value of field 'extensions'.
 java.lang.Long getPauseDuration()
          Returns the value of field 'pauseDuration'.
 java.lang.Long getPulseRate()
          Returns the value of field 'pulseRate'.
 java.lang.Long getToneDuration()
          Returns the value of field 'toneDuration'.
 boolean isValid()
          Method isValid
 void marshal(org.xml.sax.ContentHandler handler)
          Method marshal
 void marshal(java.io.Writer out)
          Method marshal
 void setCharactersToSend(java.lang.String charactersToSend)
          Sets the value of field 'charactersToSend'.
 void setConnectionToSendDigits(ConnectionID connectionToSendDigits)
          Sets the value of field 'connectionToSendDigits'.
 void setDigitMode(DigitMode digitMode)
          Sets the value of field 'digitMode'.
 void setExtensions(CSTACommonArguments extensions)
          Sets the value of field 'extensions'.
 void setPauseDuration(java.lang.Long pauseDuration)
          Sets the value of field 'pauseDuration'.
 void setPulseRate(java.lang.Long pulseRate)
          Sets the value of field 'pulseRate'.
 void setToneDuration(java.lang.Long toneDuration)
          Sets the value of field 'toneDuration'.
static GenerateDigits unmarshalGenerateDigits(java.io.Reader reader)
          Method unmarshalGenerateDigits
 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

GenerateDigits

public GenerateDigits()
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

getCharactersToSend

public java.lang.String getCharactersToSend()
Returns the value of field 'charactersToSend'.

Returns:
String

getConnectionToSendDigits

public ConnectionID getConnectionToSendDigits()
Returns the value of field 'connectionToSendDigits'.

Returns:
ConnectionID

getDigitMode

public DigitMode getDigitMode()
Returns the value of field 'digitMode'.

Returns:
DigitMode

getExtensions

public CSTACommonArguments getExtensions()
Returns the value of field 'extensions'.

Returns:
CSTACommonArguments

getPauseDuration

public java.lang.Long getPauseDuration()
Returns the value of field 'pauseDuration'.

Returns:
Long

getPulseRate

public java.lang.Long getPulseRate()
Returns the value of field 'pulseRate'.

Returns:
Long

getToneDuration

public java.lang.Long getToneDuration()
Returns the value of field 'toneDuration'.

Returns:
Long

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

setCharactersToSend

public void setCharactersToSend(java.lang.String charactersToSend)
Sets the value of field 'charactersToSend'.

Parameters:
charactersToSend - the value of field 'charactersToSend'

setConnectionToSendDigits

public void setConnectionToSendDigits(ConnectionID connectionToSendDigits)
Sets the value of field 'connectionToSendDigits'.

Parameters:
connectionToSendDigits - the value of field 'connectionToSendDigits'.

setDigitMode

public void setDigitMode(DigitMode digitMode)
Sets the value of field 'digitMode'.

Parameters:
digitMode - the value of field 'digitMode'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)
Sets the value of field 'extensions'.

Parameters:
extensions - the value of field 'extensions'.

setPauseDuration

public void setPauseDuration(java.lang.Long pauseDuration)
Sets the value of field 'pauseDuration'.

Parameters:
pauseDuration - the value of field 'pauseDuration'.

setPulseRate

public void setPulseRate(java.lang.Long pulseRate)
Sets the value of field 'pulseRate'.

Parameters:
pulseRate - the value of field 'pulseRate'.

setToneDuration

public void setToneDuration(java.lang.Long toneDuration)
Sets the value of field 'toneDuration'.

Parameters:
toneDuration - the value of field 'toneDuration'.

unmarshalGenerateDigits

public static GenerateDigits unmarshalGenerateDigits(java.io.Reader reader)
                                              throws org.exolab.castor.xml.MarshalException,
                                                     org.exolab.castor.xml.ValidationException
Method unmarshalGenerateDigits

Parameters:
reader -
Returns:
GenerateDigits
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

4.1.0.610 20071213

Copyright 2004 Avaya Inc All Rights Reserved.