ch.ecma.csta.binding
Class Start

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

All Implemented Interfaces:

java.io.Serializable

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

Not supported.

Initiates the interaction between a call and an Interactive Voice resource.

The service induces the input processing device, such as Listener or DTMF, to transition out of the Null State. For Prompt Queue, the service causes the first prompt subqueue that is not in the Playing State to transition to the Ready State. For Prompt, the service cause the voice of the Prompt to be generated and, if used with Prompt Queue, be queued to the Prompt Queue, and the hosting subqueue to transition to the Ready State.

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

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-17, Figure 6-18, and Figure 6-19 in Clause 6.1.1.4.8, "Generic Interactive Voice Device Category".

The monitoring event sequence for both device-type and call-type monitoring is a DeliveredEvent. CSTA Functional Requirements:

1. 1. For Prompt with Prompt Queue, the service request is semantically equivalent to a Queue immediately followed by a Start service on the Prompt Queue of the call. For call without a Prompt Queue joined or conferenced in, the service immediately starts the playback.
2. 2. The service request directed at a non NULL input device will be ignored with a positive acknowledgement.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Start()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
ConnectionID	getOverConnection() Returns the value of field 'overConnection'.
java.lang.String	getResource() Returns the value of field 'resource'.
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	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setOverConnection(ConnectionID overConnection) Sets the value of field 'overConnection'.
void	setResource(java.lang.String resource) Sets the value of field 'resource'.
void	setText(java.lang.String text) Sets the value of field 'text'.
static Start	unmarshalStart(java.io.Reader reader) Method unmarshalStart
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

Start

public Start()

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

getOverConnection

public ConnectionID getOverConnection()

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

Specifies the connection for which the interaction is to be started.

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

getText

public java.lang.String getText()

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

Specifies, for the Prompt Queue only, the text to be synthesized and played, and for Listener or DTMF, the text to be parsed by the grammar.

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

setOverConnection

public void setOverConnection(ConnectionID overConnection)

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

Specifies the connection for which the interaction is to be started.

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

setText

public void setText(java.lang.String text)

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

Specifies, for the Prompt Queue only, the text to be synthesized and played, and for Listener or DTMF, the text to be parsed by the grammar.

Parameters:

text - the value of field 'text'.

unmarshalStart

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

Method unmarshalStart

Parameters:

reader -

Returns:

Start

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