ch.ecma.csta.binding
Class Activate

java.lang.Object
  ch.ecma.csta.CastorObject
      ch.ecma.csta.binding.Activate

All Implemented Interfaces:

java.io.Serializable

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

Not supported.

Enables a grammar rule to be considered in matching the speech of a call.

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

Connection State Transitions:

• There are no connection state changes due to this service.
• For Interactive Voice Devices refer to for normactive resource state transitions specified, see ECMA 269 Figure 6-18, and Figure 6-19 in Clause 6.1.1.4.8, "Generic Interactive Voice Device Category".

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Activate()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getGrammarName() Returns the value of field 'grammarName'.
ConnectionID	getOverConnection() Returns the value of field 'overConnection'.
java.lang.String	getResource() Returns the value of field 'resource'.
java.lang.String	getRuleName() Returns the value of field 'ruleName'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setGrammarName(java.lang.String grammarName) Sets the value of field 'grammarName'.
void	setOverConnection(ConnectionID overConnection) Sets the value of field 'overConnection'.
void	setResource(java.lang.String resource) Sets the value of field 'resource'.
void	setRuleName(java.lang.String ruleName) Sets the value of field 'ruleName'.
static Activate	unmarshalActivate(java.io.Reader reader) Method unmarshalActivate
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

Activate

public Activate()

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

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getGrammarName

public java.lang.String getGrammarName()

Returns the value of field 'grammarName'. The field 'grammarName' has the following description:

Specifies the name of the grammar to be activated. If not specified, all of the grammars will be activated.

Returns:

String

getOverConnection

public ConnectionID getOverConnection()

Returns the value of field 'overConnection'. The field 'overConnection' has the following description:

Specifies the connection for which grammar of the Listener is to be played.

Returns:

ConnectionID

getResource

public java.lang.String getResource()

Returns the value of field 'resource'. The field 'resource' has the following description:

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

Returns:

String

getRuleName

public java.lang.String getRuleName()

Returns the value of field 'ruleName'. The field 'ruleName' has the following description:

Specifies the rule name of the grammar to be activated.

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

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setGrammarName

public void setGrammarName(java.lang.String grammarName)

Sets the value of field 'grammarName'. The field 'grammarName' has the following description:

Specifies the name of the grammar to be activated. If not specified, all of the grammars will be activated.

Parameters:

grammarName - the value of field 'grammarName'.

setOverConnection

public void setOverConnection(ConnectionID overConnection)

Sets the value of field 'overConnection'. The field 'overConnection' has the following description:

Specifies the connection for which grammar of the Listener is to be played.

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:

Specifies 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'.

setRuleName

public void setRuleName(java.lang.String ruleName)

Sets the value of field 'ruleName'. The field 'ruleName' has the following description:

Specifies the rule name of the grammar to be activated.

Parameters:

ruleName - the value of field 'ruleName'.

unmarshalActivate

public static Activate unmarshalActivate(java.io.Reader reader)
                                  throws org.exolab.castor.xml.MarshalException,
                                         org.exolab.castor.xml.ValidationException

Method unmarshalActivate

Parameters:

reader -

Returns:

Activate

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