org.csapi.jr.se.ui
Class UICollectCriteria

java.lang.Object
  |
  +--org.csapi.jr.se.ui.UICollectCriteria
All Implemented Interfaces:
java.io.Serializable

public final class UICollectCriteria
extends java.lang.Object
implements java.io.Serializable

Defines the Sequence of Data Elements that specify the additional properties for the collection of information, such as the end character, first character timeout, inter-character timeout, and maximum interaction time. The CollectMode element defines the type of data that is to be collected. DTMF and Voice Recognition can be used separately or in combination. The P_SPEECH_RECOGNITION_SUPPORTED property defines whether the voice recognition features are supported. Input is considered successful if the following applies: If the EndSequence is not present (that is an empty string): - when the InterCharTimeOut timer expires; or - when the number of valid digits received equals the MaxLength. If the EndSequence is present: - when the InterCharTimeOut timer expires; or - when the EndSequence is received; or - when the number of valid digits received equals the MaxLength. In the case the number of valid characters received is less than the MinLength when the InterCharTimeOut timer expires or when the EndSequence is received, the input is considered erroneous. The collected characters (including the EndSequence) are sent to the client application when input has been successful.

See Also:
Serialized Form

Constructor Summary
UICollectCriteria()
          Creates a new UICollectCriteria instance.
UICollectCriteria(int _minLength, int _maxLength, java.lang.String _endSequence, int _startTimeout, int _interCharTimeout, org.csapi.jr.se.ui.UICollectMode _collectMode, org.csapi.jr.se.ui.UIRecognitionCriteria _recognitionCriteria)
          Creates a new UICollectCriteria instance.
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is 'equal to' this one.
 org.csapi.jr.se.ui.UICollectMode getCollectMode()
          This method returns a collectMode.
 java.lang.String getEndSequence()
          This method returns a endSequence.
 int getInterCharTimeout()
          This method returns a interCharTimeout.
 int getMaxLength()
          This method returns a maxLength.
 int getMinLength()
          This method returns a minLength.
 org.csapi.jr.se.ui.UIRecognitionCriteria getRecognitionCriteria()
          This method returns a recognitionCriteria.
 int getStartTimeout()
          This method returns a startTimeout.
 int hashCode()
          Returns a hashcode value for the object.
 void setCollectMode(org.csapi.jr.se.ui.UICollectMode collectMode)
          This method sets a collectMode.
 void setEndSequence(java.lang.String endSequence)
          This method sets a endSequence.
 void setInterCharTimeout(int interCharTimeout)
          This method sets a interCharTimeout.
 void setMaxLength(int maxLength)
          This method sets a maxLength.
 void setMinLength(int minLength)
          This method sets a minLength.
 void setRecognitionCriteria(org.csapi.jr.se.ui.UIRecognitionCriteria recognitionCriteria)
          This method sets a recognitionCriteria.
 void setStartTimeout(int startTimeout)
          This method sets a startTimeout.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UICollectCriteria

public UICollectCriteria()
Creates a new UICollectCriteria instance.


UICollectCriteria

public UICollectCriteria(int _minLength,
                         int _maxLength,
                         java.lang.String _endSequence,
                         int _startTimeout,
                         int _interCharTimeout,
                         org.csapi.jr.se.ui.UICollectMode _collectMode,
                         org.csapi.jr.se.ui.UIRecognitionCriteria _recognitionCriteria)
Creates a new UICollectCriteria instance.

Parameters:
_minLength - Defines the minimum number of characters (for example digits) to collect. Applies to DTMF collection and voice recognition.
_maxLength - Defines the maximum number of characters (for example digits) to collect. Applies to DTMF collection and voice recognition.
_endSequence - Defines the character or characters which terminate an input of variable length, for example phone numbers. Applies to DTMF collection only.
_startTimeout - Specifies the value for the first character time-out timer. The timer is started when the announcement has been completed or has been interrupted. The user should enter the start of the response (for example first digit) before the timer expires. If the start of the response is not entered before the timer expires, the input is regarded to be erroneous. After receipt of the start of the response, which may be valid or invalid, the timer is stopped. Applies to DTMF collection and voice recognition.
_interCharTimeout - Specifies the value for the inter-character time-out timer. The timer is started when a response (for example digit) is received, and is reset and restarted when a subsequent response is received. The responses may be valid or invalid. the announcement has been completed or has been interrupted. Applies to DTMF collection only.
_collectMode - Defines the type of collection to do. Applies to DTMF collection and voice recognition. The default is DTMF collection only.
_recognitionCriteria - Defines the criteria for voice recognition.
Method Detail

getMinLength

public int getMinLength()
This method returns a minLength.

Returns:
a int value

getMaxLength

public int getMaxLength()
This method returns a maxLength.

Returns:
a int value

getEndSequence

public java.lang.String getEndSequence()
This method returns a endSequence.

Returns:
a String value

getStartTimeout

public int getStartTimeout()
This method returns a startTimeout.

Returns:
a int value

getInterCharTimeout

public int getInterCharTimeout()
This method returns a interCharTimeout.

Returns:
a int value

getCollectMode

public org.csapi.jr.se.ui.UICollectMode getCollectMode()
This method returns a collectMode.

Returns:
a org.csapi.jr.se.ui.UICollectMode value

getRecognitionCriteria

public org.csapi.jr.se.ui.UIRecognitionCriteria getRecognitionCriteria()
This method returns a recognitionCriteria.

Returns:
a org.csapi.jr.se.ui.UIRecognitionCriteria value

setMinLength

public void setMinLength(int minLength)
This method sets a minLength.


setMaxLength

public void setMaxLength(int maxLength)
This method sets a maxLength.


setEndSequence

public void setEndSequence(java.lang.String endSequence)
This method sets a endSequence.


setStartTimeout

public void setStartTimeout(int startTimeout)
This method sets a startTimeout.


setInterCharTimeout

public void setInterCharTimeout(int interCharTimeout)
This method sets a interCharTimeout.


setCollectMode

public void setCollectMode(org.csapi.jr.se.ui.UICollectMode collectMode)
This method sets a collectMode.


setRecognitionCriteria

public void setRecognitionCriteria(org.csapi.jr.se.ui.UIRecognitionCriteria recognitionCriteria)
This method sets a recognitionCriteria.


equals

public boolean equals(java.lang.Object o)
Indicates whether some other object is 'equal to' this one.

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Returns a hashcode value for the object.

Overrides:
hashCode in class java.lang.Object