cisco.uc.cuae.legacy
Class MediaControl.GatherDigitsResult

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

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

MediaControl

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

See Also:

Serialized Form

Field Summary

java.lang.String	connectionId The value of the ConnectionId result data is the same as that specified as an action parameter.
java.lang.String	digits The digits gathered from the buffer at the start of the GatherDigits, as well as those that occurred throughout the duration of the action (from GatherDigits until GatherDigits_Complete.
java.lang.Integer	elapsedTime The amount of time taken to perform the GatherDigits (in milliseconds).
java.lang.String	operationId A unique identifier to this GatherDigits operation.
java.lang.String	resultCode A numeric code indicating the result status of the operation.
CuaeCommon.CuaeResult	returnValue
MediaControl.TerminationCondition	terminationCondition The condition which caused the GatherDigits to stop.

Constructor Summary

MediaControl.GatherDigitsResult()
Constructs the GatherDigitsResult.

MediaControl.GatherDigitsResult(CuaeCommon.CuaeResult returnValue, java.lang.String connectionId, java.lang.String resultCode, java.lang.String operationId, MediaControl.TerminationCondition terminationCondition, java.lang.Integer elapsedTime, java.lang.String digits)
Constructs the GatherDigitsResult.

Method Summary

java.lang.String	getConnectionId() Gets the value.
java.lang.String	getDigits() Gets the value.
java.lang.Integer	getElapsedTime() Gets the value.
java.lang.String	getOperationId() Gets the value.
java.lang.String	getResultCode() Gets the value.
CuaeCommon.CuaeResult	getReturnValue() Gets the value.
MediaControl.TerminationCondition	getTerminationCondition() Gets the value.
void	setConnectionId(java.lang.String value) Sets the value.
void	setDigits(java.lang.String value) Sets the value.
void	setElapsedTime(java.lang.Integer value) Sets the value.
void	setOperationId(java.lang.String value) Sets the value.
void	setResultCode(java.lang.String value) Sets the value.
void	setReturnValue(CuaeCommon.CuaeResult value) Sets the value.
void	setTerminationCondition(MediaControl.TerminationCondition 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

returnValue

public CuaeCommon.CuaeResult returnValue

connectionId

public java.lang.String connectionId

The value of the ConnectionId result data is the same as that specified as an action parameter. This ConnectionId is what one would later specify in StopMediaOperation if one were to abort the command programmatically.

resultCode

public java.lang.String resultCode

A numeric code indicating the result status of the operation. A '0' indicates success; a positive number indicates an error. Please reference the Media Control Error Codes table for descriptions on specific error codes.

operationId

public java.lang.String operationId

A unique identifier to this GatherDigits operation. This identifier can later be used by the StopMediaOperation action to stop just this particular operation on a connection, even if multiple media operations are concurrently executing on that connection.

terminationCondition

public MediaControl.TerminationCondition terminationCondition

The condition which caused the GatherDigits to stop. Possible values for termination condition are as follows: digitlist - One of the digits specified by TermCondDigitList has occurred. maxtime - The amount of time specified by TermCondMaxTime has elapsed (in milliseconds). maxdigits - The number of digits specified by TermCondMaxDigits has occurred. digit - The digit specified by TermCondDigit has occurred. interdigdelay - The amount of time specified by TermCondInterDigitDelay has elapsed after the last occurring digit (in milliseconds). digitpattern - The sequence of digits specified by TermCondNonSilence has occurred. userstop - The StopMediaOperation was used on operation to abort it. autostop - The Call Control API ended the operation due to the call ending that was associated with the connection. The normal reasons a call may end are Hangup or BlindTransfer. timeout - The amount of time specified by CommandTimeout has elapsed (in milliseconds). This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".

elapsedTime

public java.lang.Integer elapsedTime

The amount of time taken to perform the GatherDigits (in milliseconds). This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".

digits

public java.lang.String digits

The digits gathered from the buffer at the start of the GatherDigits, as well as those that occurred throughout the duration of the action (from GatherDigits until GatherDigits_Complete. Any digits that contributed to the termination condition are included. This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".

Constructor Detail

MediaControl.GatherDigitsResult

public MediaControl.GatherDigitsResult()

Constructs the GatherDigitsResult. Don't init any fields.

MediaControl.GatherDigitsResult

public MediaControl.GatherDigitsResult(CuaeCommon.CuaeResult returnValue,
                                       java.lang.String connectionId,
                                       java.lang.String resultCode,
                                       java.lang.String operationId,
                                       MediaControl.TerminationCondition terminationCondition,
                                       java.lang.Integer elapsedTime,
                                       java.lang.String digits)

Constructs the GatherDigitsResult.

Parameters:

connectionId - The value of the ConnectionId result data is the same as that specified connectionId as an action parameter. This ConnectionId is what one would later specify connectionId in StopMediaOperation if one were to abort the command programmatically. connectionId

resultCode - A numeric code indicating the result status of the operation. A '0' resultCode indicates success; a positive number indicates an error. Please reference resultCode the Media Control Error Codes table for descriptions on specific error resultCode codes. resultCode

operationId - A unique identifier to this GatherDigits operation. This identifier can operationId later be used by the StopMediaOperation action to stop just this operationId particular operation on a connection, even if multiple media operations operationId are concurrently executing on that connection. operationId

terminationCondition - The condition which caused the GatherDigits to stop. Possible values for terminationCondition termination condition are as follows: terminationCondition terminationCondition digitlist - One of the digits specified by TermCondDigitList has terminationCondition occurred. terminationCondition maxtime - The amount of time specified by TermCondMaxTime has elapsed (in terminationCondition milliseconds). terminationCondition maxdigits - The number of digits specified by TermCondMaxDigits has terminationCondition occurred. terminationCondition digit - The digit specified by TermCondDigit has occurred. terminationCondition interdigdelay - The amount of time specified by TermCondInterDigitDelay terminationCondition has elapsed after the last occurring digit (in terminationCondition milliseconds). terminationCondition digitpattern - The sequence of digits specified by TermCondNonSilence has terminationCondition occurred. terminationCondition userstop - The StopMediaOperation was used on operation to abort it. terminationCondition autostop - The Call Control API ended the operation due to the call terminationCondition ending that was associated with the connection. The normal terminationCondition reasons a call may end are Hangup or BlindTransfer. terminationCondition timeout - The amount of time specified by CommandTimeout has elapsed (in terminationCondition milliseconds). terminationCondition terminationCondition This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".

elapsedTime - The amount of time taken to perform the GatherDigits (in milliseconds). elapsedTime elapsedTime This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".

digits - The digits gathered from the buffer at the start of the GatherDigits, as digits well as those that occurred throughout the duration of the action (from digits GatherDigits until GatherDigits_Complete. Any digits that contributed to digits the termination condition are included. digits digits This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getReturnValue

public CuaeCommon.CuaeResult getReturnValue()

Gets the value.

Returns:

the value.

setReturnValue

public void setReturnValue(CuaeCommon.CuaeResult value)

Sets the value.

Parameters:

value - the value.

getConnectionId

public java.lang.String getConnectionId()

Gets the value. The value of the ConnectionId result data is the same as that specified as an action parameter. This ConnectionId is what one would later specify in StopMediaOperation if one were to abort the command programmatically.

Returns:

the value.

setConnectionId

public void setConnectionId(java.lang.String value)

Sets the value. The value of the ConnectionId result data is the same as that specified as an action parameter. This ConnectionId is what one would later specify in StopMediaOperation if one were to abort the command programmatically.

Parameters:

value - the value.

getResultCode

public java.lang.String getResultCode()

Gets the value. A numeric code indicating the result status of the operation. A '0' indicates success; a positive number indicates an error. Please reference the Media Control Error Codes table for descriptions on specific error codes.

Returns:

the value.

setResultCode

public void setResultCode(java.lang.String value)

Sets the value. A numeric code indicating the result status of the operation. A '0' indicates success; a positive number indicates an error. Please reference the Media Control Error Codes table for descriptions on specific error codes.

Parameters:

value - the value.

getOperationId

public java.lang.String getOperationId()

Gets the value. A unique identifier to this GatherDigits operation. This identifier can later be used by the StopMediaOperation action to stop just this particular operation on a connection, even if multiple media operations are concurrently executing on that connection.

Returns:

the value.

setOperationId

public void setOperationId(java.lang.String value)

Sets the value. A unique identifier to this GatherDigits operation. This identifier can later be used by the StopMediaOperation action to stop just this particular operation on a connection, even if multiple media operations are concurrently executing on that connection.

Parameters:

value - the value.

getTerminationCondition

public MediaControl.TerminationCondition getTerminationCondition()

Gets the value. The condition which caused the GatherDigits to stop. Possible values for termination condition are as follows: digitlist - One of the digits specified by TermCondDigitList has occurred. maxtime - The amount of time specified by TermCondMaxTime has elapsed (in milliseconds). maxdigits - The number of digits specified by TermCondMaxDigits has occurred. digit - The digit specified by TermCondDigit has occurred. interdigdelay - The amount of time specified by TermCondInterDigitDelay has elapsed after the last occurring digit (in milliseconds). digitpattern - The sequence of digits specified by TermCondNonSilence has occurred. userstop - The StopMediaOperation was used on operation to abort it. autostop - The Call Control API ended the operation due to the call ending that was associated with the connection. The normal reasons a call may end are Hangup or BlindTransfer. timeout - The amount of time specified by CommandTimeout has elapsed (in milliseconds). This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".

Returns:

the value.

setTerminationCondition

public void setTerminationCondition(MediaControl.TerminationCondition value)

Sets the value. The condition which caused the GatherDigits to stop. Possible values for termination condition are as follows: digitlist - One of the digits specified by TermCondDigitList has occurred. maxtime - The amount of time specified by TermCondMaxTime has elapsed (in milliseconds). maxdigits - The number of digits specified by TermCondMaxDigits has occurred. digit - The digit specified by TermCondDigit has occurred. interdigdelay - The amount of time specified by TermCondInterDigitDelay has elapsed after the last occurring digit (in milliseconds). digitpattern - The sequence of digits specified by TermCondNonSilence has occurred. userstop - The StopMediaOperation was used on operation to abort it. autostop - The Call Control API ended the operation due to the call ending that was associated with the connection. The normal reasons a call may end are Hangup or BlindTransfer. timeout - The amount of time specified by CommandTimeout has elapsed (in milliseconds). This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".

Parameters:

value - the value.

getElapsedTime

public java.lang.Integer getElapsedTime()

Gets the value. The amount of time taken to perform the GatherDigits (in milliseconds). This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".

Returns:

the value.

setElapsedTime

public void setElapsedTime(java.lang.Integer value)

Sets the value. The amount of time taken to perform the GatherDigits (in milliseconds). This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".

Parameters:

value - the value.

getDigits

public java.lang.String getDigits()

Gets the value. The digits gathered from the buffer at the start of the GatherDigits, as well as those that occurred throughout the duration of the action (from GatherDigits until GatherDigits_Complete. Any digits that contributed to the termination condition are included. This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".

Returns:

the value.

setDigits

public void setDigits(java.lang.String value)

Sets the value. The digits gathered from the buffer at the start of the GatherDigits, as well as those that occurred throughout the duration of the action (from GatherDigits until GatherDigits_Complete. Any digits that contributed to the termination condition are included. This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".

Parameters:

value - the value.