4.1.0.610 20071213

ch.ecma.csta.binding
Class RecognizedEvent

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

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

Not supported.

Indicates an outcome above the rejection threshold has been detected. For a listener under the multiple mode, the resource state can be either Speech Detected or Null. Otherwise, this event indicates the resource has entered the Null resource state.

For an illustration of this service, see ECMA 269, section 26.2.8.

The Completed Event could be caused by the following:

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

Constructor Summary
RecognizedEvent()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
          Note: hashCode() has not been overriden
 EventCause getCause()
          Returns the value of field 'cause'.
 CSTACommonArguments getExtensions()
          Returns the value of field 'extensions'.
 java.lang.String getMonitorCrossRefID()
          Returns the value of field 'monitorCrossRefID'.
 ConnectionID getOverConnection()
          Returns the value of field 'overConnection'.
 java.lang.String getResource()
          Returns the value of field 'resource'.
 java.lang.String getResult()
          Returns the value of field 'result'.
 ServicesPermitted getServicesPermitted()
          Returns the value of field 'servicesPermitted'.
 java.lang.String getText()
          Returns the value of field 'text'.
 boolean isValid()
          Method isValid
 void marshal(org.xml.sax.ContentHandler handler)
          Method marshal
 void marshal(java.io.Writer out)
          Method marshal
 void setCause(EventCause cause)
          Sets the value of field 'cause'.
 void setExtensions(CSTACommonArguments extensions)
          Sets the value of field 'extensions'.
 void setMonitorCrossRefID(java.lang.String monitorCrossRefID)
          Sets the value of field 'monitorCrossRefID'.
 void setOverConnection(ConnectionID overConnection)
          Sets the value of field 'overConnection'.
 void setResource(java.lang.String resource)
          Sets the value of field 'resource'.
 void setResult(java.lang.String result)
          Sets the value of field 'result'.
 void setServicesPermitted(ServicesPermitted servicesPermitted)
          Sets the value of field 'servicesPermitted'.
 void setText(java.lang.String text)
          Sets the value of field 'text'.
static RecognizedEvent unmarshalRecognizedEvent(java.io.Reader reader)
          Method unmarshalRecognizedEvent
 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

RecognizedEvent

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

getCause

public EventCause getCause()
Returns the value of field 'cause'.

Returns:
EventCause

getExtensions

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

Returns:
CSTACommonArguments

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()
Returns the value of field 'monitorCrossRefID'.

Returns:
String

getOverConnection

public ConnectionID getOverConnection()
Returns the value of field 'overConnection'. The field 'overConnection' has the following description:

Indicates the connection from which the event is generated.

Returns:
ConnectionID

getResource

public java.lang.String getResource()
Returns the value of field 'resource'. The field 'resource' has the following description:

Indicates the interactive voice resource for this service. This parameter is required if there are multiple interactive voice resource per connection.

Returns:
String

getResult

public java.lang.String getResult()
Returns the value of field 'result'. The field 'result' has the following description:

Indicates the processed outcome from the input device. The result string can be in either SALT SML or W3C EMMA format, which include confidence measures as well as semantic parses.

Returns:
String

getServicesPermitted

public ServicesPermitted getServicesPermitted()
Returns the value of field 'servicesPermitted'.

Returns:
ServicesPermitted

getText

public java.lang.String getText()
Returns the value of field 'text'. The field 'text' has the following description:

A text transcription for the result.

Returns:
String

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

setCause

public void setCause(EventCause cause)
Sets the value of field 'cause'.

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

setExtensions

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

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

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)
Sets the value of field 'monitorCrossRefID'.

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

setOverConnection

public void setOverConnection(ConnectionID overConnection)
Sets the value of field 'overConnection'. The field 'overConnection' has the following description:

Indicates the connection from which the event is generated.

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

setResource

public void setResource(java.lang.String resource)
Sets the value of field 'resource'. The field 'resource' has the following description:

Indicates the interactive voice resource for this service. This parameter is required if there are multiple interactive voice resource per connection.

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

setResult

public void setResult(java.lang.String result)
Sets the value of field 'result'. The field 'result' has the following description:

Indicates the processed outcome from the input device. The result string can be in either SALT SML or W3C EMMA format, which include confidence measures as well as semantic parses.

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

setServicesPermitted

public void setServicesPermitted(ServicesPermitted servicesPermitted)
Sets the value of field 'servicesPermitted'.

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

setText

public void setText(java.lang.String text)
Sets the value of field 'text'. The field 'text' has the following description:

A text transcription for the result.

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

unmarshalRecognizedEvent

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

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