cisco.uc.cuae.legacy
Class MediaControl.VoiceRecognitionResult

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

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

MediaControl

public static class MediaControl.VoiceRecognitionResult
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	meaning The top-match phrase recognized by Nuance OSR.
java.lang.String	operationId A unique identifier to this VoiceRecognition operation.
java.lang.String	resultCode A numeric code indicating the result status of the operation.
CuaeCommon.CuaeResult	returnValue
java.lang.Integer	score The confidence score of the Meaning.
MediaControl.TerminationCondition	terminationCondition Describes the condition which caused the operation to complete.
java.lang.String	vR_XMLResult The full recognition result in XML format of the action.

Constructor Summary

MediaControl.VoiceRecognitionResult()
Constructs the VoiceRecognitionResult.

MediaControl.VoiceRecognitionResult(CuaeCommon.CuaeResult returnValue, java.lang.String operationId, java.lang.String resultCode, java.lang.String connectionId, java.lang.String meaning, MediaControl.TerminationCondition terminationCondition, java.lang.Integer score, java.lang.String vR_XMLResult)
Constructs the VoiceRecognitionResult.

Method Summary

java.lang.String	getConnectionId() Gets the value.
java.lang.String	getMeaning() Gets the value.
java.lang.String	getOperationId() Gets the value.
java.lang.String	getResultCode() Gets the value.
CuaeCommon.CuaeResult	getReturnValue() Gets the value.
java.lang.Integer	getScore() Gets the value.
MediaControl.TerminationCondition	getTerminationCondition() Gets the value.
java.lang.String	getVR_XMLResult() Gets the value.
void	setConnectionId(java.lang.String value) Sets the value.
void	setMeaning(java.lang.String 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	setScore(java.lang.Integer value) Sets the value.
void	setTerminationCondition(MediaControl.TerminationCondition value) Sets the value.
void	setVR_XMLResult(java.lang.String 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

operationId

public java.lang.String operationId

A unique identifier to this VoiceRecognition 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.

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.

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.

meaning

public java.lang.String meaning

The top-match phrase recognized by Nuance OSR. This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

terminationCondition

public MediaControl.TerminationCondition terminationCondition

Describes the condition which caused the operation to complete. This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

score

public java.lang.Integer score

The confidence score of the Meaning. The value can be between 0 - 1000. With VR_XMLResult, scores can be between 0 - 100. This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

vR_XMLResult

public java.lang.String vR_XMLResult

The full recognition result in XML format of the action. All scores and meanings are returned in this XML content. To help parse through the full result data, a number of helper actions exist: null - Returns the number of matching results. null - Returns the score and meaning of a result at a specified index. null - Returns any results matching the specified string matching criteria for meaning. null - Returns any results matching the specified criteria for scores. null - Allows one to specify user-defined XPath expressions to allow custom parsing of the results. Each of the VoiceRecResult methods take the XML content as a VoiceRecResultList, so in general one should create a local variable of type VoiceRecResultList initialized with this action parameter. The XmlQuery action takes the XML content as a String, so if you intend to use the XmlQuery action, you should make a String variable that initializes with this action parameter. It is also valid to have two variables of different types that both initialize with the same action parameter. This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

Constructor Detail

MediaControl.VoiceRecognitionResult

public MediaControl.VoiceRecognitionResult()

Constructs the VoiceRecognitionResult. Don't init any fields.

MediaControl.VoiceRecognitionResult

public MediaControl.VoiceRecognitionResult(CuaeCommon.CuaeResult returnValue,
                                           java.lang.String operationId,
                                           java.lang.String resultCode,
                                           java.lang.String connectionId,
                                           java.lang.String meaning,
                                           MediaControl.TerminationCondition terminationCondition,
                                           java.lang.Integer score,
                                           java.lang.String vR_XMLResult)

Constructs the VoiceRecognitionResult.

Parameters:

operationId - A unique identifier to this VoiceRecognition operation. This identifier operationId can 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

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

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

meaning - The top-match phrase recognized by Nuance OSR. meaning meaning This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

terminationCondition - Describes the condition which caused the operation to complete. terminationCondition terminationCondition This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

score - The confidence score of the Meaning. The value can be between 0 - 1000. score With VR_XMLResult, scores can be between 0 - 100. score score This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

vR_XMLResult - The full recognition result in XML format of the action. All scores and vR_XMLResult meanings are returned in this XML content. To help parse through the full vR_XMLResult result data, a number of helper actions exist: vR_XMLResult vR_XMLResult null - Returns the number of matching results. vR_XMLResult null - Returns the score and meaning of a result at a specified index. vR_XMLResult null - Returns any results matching the specified string matching vR_XMLResult criteria for meaning. vR_XMLResult null - Returns any results matching the specified criteria for scores. vR_XMLResult null - Allows one to specify user-defined XPath expressions to allow vR_XMLResult custom parsing of the results. vR_XMLResult vR_XMLResult Each of the VoiceRecResult methods take the XML content as a vR_XMLResult VoiceRecResultList, so in general one should create a local variable of vR_XMLResult type VoiceRecResultList initialized with this action parameter. The vR_XMLResult XmlQuery action takes the XML content as a String, so if you intend to use vR_XMLResult the XmlQuery action, you should make a String variable that initializes vR_XMLResult with this action parameter. It is also valid to have two variables of vR_XMLResult different types that both initialize with the same action parameter. vR_XMLResult vR_XMLResult This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_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.

getOperationId

public java.lang.String getOperationId()

Gets the value. A unique identifier to this VoiceRecognition 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 VoiceRecognition 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.

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.

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.

getMeaning

public java.lang.String getMeaning()

Gets the value. The top-match phrase recognized by Nuance OSR. This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

Returns:

the value.

setMeaning

public void setMeaning(java.lang.String value)

Sets the value. The top-match phrase recognized by Nuance OSR. This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

Parameters:

value - the value.

getTerminationCondition

public MediaControl.TerminationCondition getTerminationCondition()

Gets the value. Describes the condition which caused the operation to complete. This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

Returns:

the value.

setTerminationCondition

public void setTerminationCondition(MediaControl.TerminationCondition value)

Sets the value. Describes the condition which caused the operation to complete. This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

Parameters:

value - the value.

getScore

public java.lang.Integer getScore()

Gets the value. The confidence score of the Meaning. The value can be between 0 - 1000. With VR_XMLResult, scores can be between 0 - 100. This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

Returns:

the value.

setScore

public void setScore(java.lang.Integer value)

Sets the value. The confidence score of the Meaning. The value can be between 0 - 1000. With VR_XMLResult, scores can be between 0 - 100. This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

Parameters:

value - the value.

getVR_XMLResult

public java.lang.String getVR_XMLResult()

Gets the value. The full recognition result in XML format of the action. All scores and meanings are returned in this XML content. To help parse through the full result data, a number of helper actions exist: null - Returns the number of matching results. null - Returns the score and meaning of a result at a specified index. null - Returns any results matching the specified string matching criteria for meaning. null - Returns any results matching the specified criteria for scores. null - Allows one to specify user-defined XPath expressions to allow custom parsing of the results. Each of the VoiceRecResult methods take the XML content as a VoiceRecResultList, so in general one should create a local variable of type VoiceRecResultList initialized with this action parameter. The XmlQuery action takes the XML content as a String, so if you intend to use the XmlQuery action, you should make a String variable that initializes with this action parameter. It is also valid to have two variables of different types that both initialize with the same action parameter. This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

Returns:

the value.

setVR_XMLResult

public void setVR_XMLResult(java.lang.String value)

Sets the value. The full recognition result in XML format of the action. All scores and meanings are returned in this XML content. To help parse through the full result data, a number of helper actions exist: null - Returns the number of matching results. null - Returns the score and meaning of a result at a specified index. null - Returns any results matching the specified string matching criteria for meaning. null - Returns any results matching the specified criteria for scores. null - Allows one to specify user-defined XPath expressions to allow custom parsing of the results. Each of the VoiceRecResult methods take the XML content as a VoiceRecResultList, so in general one should create a local variable of type VoiceRecResultList initialized with this action parameter. The XmlQuery action takes the XML content as a String, so if you intend to use the XmlQuery action, you should make a String variable that initializes with this action parameter. It is also valid to have two variables of different types that both initialize with the same action parameter. This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".

Parameters:

value - the value.