ch.ecma.csta.binding
Class BookmarkReachedEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Not supported.

Indicates a mark in the speech synthesis markup language has been reached. No resource state is changed as a result of this event.

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

The Bookmark Reached Event could be caused by the following:

• The prompt rendering has reached a bookmark in the speech synthesis markup.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

BookmarkReachedEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
java.lang.String	getBookmark() Returns the value of field 'bookmark'.
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'.
ServicesPermitted	getServicesPermitted() Returns the value of field 'servicesPermitted'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setBookmark(java.lang.String bookmark) Sets the value of field 'bookmark'.
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	setServicesPermitted(ServicesPermitted servicesPermitted) Sets the value of field 'servicesPermitted'.
static BookmarkReachedEvent	unmarshalBookmarkReachedEvent(java.io.Reader reader) Method unmarshalBookmarkReachedEvent
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

BookmarkReachedEvent

public BookmarkReachedEvent()

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

getBookmark

public java.lang.String getBookmark()

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

Indicates the name of bookmark in the synthesis markup being reached.

Returns:

String

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

getServicesPermitted

public ServicesPermitted getServicesPermitted()

Returns the value of field 'servicesPermitted'.

Returns:

ServicesPermitted

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

setBookmark

public void setBookmark(java.lang.String bookmark)

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

Indicates the name of bookmark in the synthesis markup being reached.

Parameters:

bookmark - the value of field 'bookmark'.

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

setServicesPermitted

public void setServicesPermitted(ServicesPermitted servicesPermitted)

Sets the value of field 'servicesPermitted'.

Parameters:

servicesPermitted - the value of field 'servicesPermitted'.

unmarshalBookmarkReachedEvent

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

Method unmarshalBookmarkReachedEvent

Parameters:

reader -

Returns:

BookmarkReachedEvent

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