cisco.uc.cuae.legacy
Class MediaControl.GatherDigitsOptions

java.lang.Object
  cisco.uc.cuae.legacy.MediaControl.GatherDigitsOptions

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

MediaControl

public static class MediaControl.GatherDigitsOptions
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

java.lang.Long	commandTimeout Indicates a command timeout value (in milliseconds).
java.lang.String	state9 Optional user state information which is guaranteed present as the State event parameter in GatherDigits_Complete or GatherDigits_Failed.
java.lang.String	termCondDigit A specific digit that will cause the GatherDigits operation to terminate.
java.lang.String	termCondDigitList A list of digits that will cause the GatherDigits operation to terminate, if any one of the digits in the list is inputted.
java.lang.String	termCondDigitPattern A specific sequence of digits that will cause the GatherDigits operation to terminate.
java.lang.Long	termCondInterDigitDelay The amount of time between digits which will cause the GatherDigits operation to terminate.
java.lang.Long	termCondMaxDigits The number of digits that will cause the GatherDigits operation to terminate.
java.lang.Long	termCondMaxTime The amount of time (in milliseconds) that can elapse before terminating the GatherDigits operation.
java.lang.Integer	timeout The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action.

Constructor Summary

MediaControl.GatherDigitsOptions()
Constructs the GatherDigitsOptions.

MediaControl.GatherDigitsOptions(java.lang.Long commandTimeout, java.lang.Long termCondMaxTime, java.lang.Long termCondMaxDigits, java.lang.String termCondDigit, java.lang.String termCondDigitList, java.lang.String termCondDigitPattern, java.lang.Long termCondInterDigitDelay, java.lang.String state9, java.lang.Integer timeout)
Constructs the GatherDigitsOptions.

Method Summary

java.lang.Long	getCommandTimeout() Gets the value.
java.lang.String	getState9() Gets the value.
java.lang.String	getTermCondDigit() Gets the value.
java.lang.String	getTermCondDigitList() Gets the value.
java.lang.String	getTermCondDigitPattern() Gets the value.
java.lang.Long	getTermCondInterDigitDelay() Gets the value.
java.lang.Long	getTermCondMaxDigits() Gets the value.
java.lang.Long	getTermCondMaxTime() Gets the value.
java.lang.Integer	getTimeout() Gets the value.
void	setCommandTimeout(java.lang.Long value) Sets the value.
void	setState9(java.lang.String value) Sets the value.
void	setTermCondDigit(java.lang.String value) Sets the value.
void	setTermCondDigitList(java.lang.String value) Sets the value.
void	setTermCondDigitPattern(java.lang.String value) Sets the value.
void	setTermCondInterDigitDelay(java.lang.Long value) Sets the value.
void	setTermCondMaxDigits(java.lang.Long value) Sets the value.
void	setTermCondMaxTime(java.lang.Long value) Sets the value.
void	setTimeout(java.lang.Integer value) Sets the value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

commandTimeout

public java.lang.Long commandTimeout

Indicates a command timeout value (in milliseconds). If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of timeout.

termCondMaxTime

public java.lang.Long termCondMaxTime

The amount of time (in milliseconds) that can elapse before terminating the GatherDigits operation. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of maxtime.

termCondMaxDigits

public java.lang.Long termCondMaxDigits

The number of digits that will cause the GatherDigits operation to terminate. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of maxdigits.

termCondDigit

public java.lang.String termCondDigit

A specific digit that will cause the GatherDigits operation to terminate. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of digit.

termCondDigitList

public java.lang.String termCondDigitList

A list of digits that will cause the GatherDigits operation to terminate, if any one of the digits in the list is inputted. The list has no delimiters. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of digitlist.

termCondDigitPattern

public java.lang.String termCondDigitPattern

A specific sequence of digits that will cause the GatherDigits operation to terminate. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of digitpattern.

termCondInterDigitDelay

public java.lang.Long termCondInterDigitDelay

The amount of time between digits which will cause the GatherDigits operation to terminate. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of interdigdelay.

state9

public java.lang.String state9

Optional user state information which is guaranteed present as the State event parameter in GatherDigits_Complete or GatherDigits_Failed.

timeout

public java.lang.Integer timeout

The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.

Constructor Detail

MediaControl.GatherDigitsOptions

public MediaControl.GatherDigitsOptions()

Constructs the GatherDigitsOptions. Don't init any fields.

MediaControl.GatherDigitsOptions

public MediaControl.GatherDigitsOptions(java.lang.Long commandTimeout,
                                        java.lang.Long termCondMaxTime,
                                        java.lang.Long termCondMaxDigits,
                                        java.lang.String termCondDigit,
                                        java.lang.String termCondDigitList,
                                        java.lang.String termCondDigitPattern,
                                        java.lang.Long termCondInterDigitDelay,
                                        java.lang.String state9,
                                        java.lang.Integer timeout)

Constructs the GatherDigitsOptions.

Parameters:

commandTimeout - Indicates a command timeout value (in milliseconds). If this condition is commandTimeout met, the GatherDigits command will result in the GatherDigits_Complete commandTimeout event with a TerminationCondition of timeout. commandTimeout

termCondMaxTime - The amount of time (in milliseconds) that can elapse before terminating the termCondMaxTime GatherDigits operation. If this condition is met, the GatherDigits command termCondMaxTime will result in the GatherDigits_Complete event with a TerminationCondition termCondMaxTime of maxtime. termCondMaxTime

termCondMaxDigits - The number of digits that will cause the GatherDigits operation to termCondMaxDigits terminate. If this condition is met, the GatherDigits command will result termCondMaxDigits in the GatherDigits_Complete event with a TerminationCondition of termCondMaxDigits maxdigits. termCondMaxDigits

termCondDigit - A specific digit that will cause the GatherDigits operation to terminate. termCondDigit If this condition is met, the GatherDigits command will result in the termCondDigit GatherDigits_Complete event with a TerminationCondition of digit. termCondDigit

termCondDigitList - A list of digits that will cause the GatherDigits operation to terminate, termCondDigitList if any one of the digits in the list is inputted. The list has no termCondDigitList delimiters. If this condition is met, the GatherDigits command will result termCondDigitList in the GatherDigits_Complete event with a TerminationCondition of termCondDigitList digitlist. termCondDigitList

termCondDigitPattern - A specific sequence of digits that will cause the GatherDigits operation to termCondDigitPattern terminate. If this condition is met, the GatherDigits command will result termCondDigitPattern in the GatherDigits_Complete event with a TerminationCondition of termCondDigitPattern digitpattern. termCondDigitPattern

termCondInterDigitDelay - The amount of time between digits which will cause the GatherDigits termCondInterDigitDelay operation to terminate. If this condition is met, the GatherDigits command termCondInterDigitDelay will result in the GatherDigits_Complete event with a TerminationCondition termCondInterDigitDelay of interdigdelay. termCondInterDigitDelay

state9 - Optional user state information which is guaranteed present as the State state9 event parameter in GatherDigits_Complete or GatherDigits_Failed. state9

timeout - The Timeout property specifies to the Application Runtime Environment how timeout long to wait for a response from the provider for the current action. The timeout ReturnValue returned in this case is Timeout. The value must be a literal timeout value in milliseconds. timeout

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCommandTimeout

public java.lang.Long getCommandTimeout()

Gets the value. Indicates a command timeout value (in milliseconds). If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of timeout.

Returns:

the value.

setCommandTimeout

public void setCommandTimeout(java.lang.Long value)

Sets the value. Indicates a command timeout value (in milliseconds). If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of timeout.

Parameters:

value - the value.

getTermCondMaxTime

public java.lang.Long getTermCondMaxTime()

Gets the value. The amount of time (in milliseconds) that can elapse before terminating the GatherDigits operation. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of maxtime.

Returns:

the value.

setTermCondMaxTime

public void setTermCondMaxTime(java.lang.Long value)

Sets the value. The amount of time (in milliseconds) that can elapse before terminating the GatherDigits operation. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of maxtime.

Parameters:

value - the value.

getTermCondMaxDigits

public java.lang.Long getTermCondMaxDigits()

Gets the value. The number of digits that will cause the GatherDigits operation to terminate. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of maxdigits.

Returns:

the value.

setTermCondMaxDigits

public void setTermCondMaxDigits(java.lang.Long value)

Sets the value. The number of digits that will cause the GatherDigits operation to terminate. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of maxdigits.

Parameters:

value - the value.

getTermCondDigit

public java.lang.String getTermCondDigit()

Gets the value. A specific digit that will cause the GatherDigits operation to terminate. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of digit.

Returns:

the value.

setTermCondDigit

public void setTermCondDigit(java.lang.String value)

Sets the value. A specific digit that will cause the GatherDigits operation to terminate. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of digit.

Parameters:

value - the value.

getTermCondDigitList

public java.lang.String getTermCondDigitList()

Gets the value. A list of digits that will cause the GatherDigits operation to terminate, if any one of the digits in the list is inputted. The list has no delimiters. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of digitlist.

Returns:

the value.

setTermCondDigitList

public void setTermCondDigitList(java.lang.String value)

Sets the value. A list of digits that will cause the GatherDigits operation to terminate, if any one of the digits in the list is inputted. The list has no delimiters. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of digitlist.

Parameters:

value - the value.

getTermCondDigitPattern

public java.lang.String getTermCondDigitPattern()

Gets the value. A specific sequence of digits that will cause the GatherDigits operation to terminate. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of digitpattern.

Returns:

the value.

setTermCondDigitPattern

public void setTermCondDigitPattern(java.lang.String value)

Sets the value. A specific sequence of digits that will cause the GatherDigits operation to terminate. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of digitpattern.

Parameters:

value - the value.

getTermCondInterDigitDelay

public java.lang.Long getTermCondInterDigitDelay()

Gets the value. The amount of time between digits which will cause the GatherDigits operation to terminate. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of interdigdelay.

Returns:

the value.

setTermCondInterDigitDelay

public void setTermCondInterDigitDelay(java.lang.Long value)

Sets the value. The amount of time between digits which will cause the GatherDigits operation to terminate. If this condition is met, the GatherDigits command will result in the GatherDigits_Complete event with a TerminationCondition of interdigdelay.

Parameters:

value - the value.

getState9

public java.lang.String getState9()

Gets the value. Optional user state information which is guaranteed present as the State event parameter in GatherDigits_Complete or GatherDigits_Failed.

Returns:

the value.

setState9

public void setState9(java.lang.String value)

Sets the value. Optional user state information which is guaranteed present as the State event parameter in GatherDigits_Complete or GatherDigits_Failed.

Parameters:

value - the value.

getTimeout

public java.lang.Integer getTimeout()

Gets the value. The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.

Returns:

the value.

setTimeout

public void setTimeout(java.lang.Integer value)

Sets the value. The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.

Parameters:

value - the value.