ch.ecma.csta.binding
Class PlayEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Indicates that a message is being played.

The Play Event could be caused by either of the following:

• The next message within a sequence of messages is being played (in the case where concurrent play operations are queued, for example).
• A message is being played (a more specific cause cannot be provided).

The PlayEvent indicates that a message is being played.

The PlayEvent occurs as a result of these requests:

• PlayMessage
• Resume
• ResumePlaying

The parameters of the PlayEvent structure are:

PlayEvent Parameters
monitorCrossRefID	Not used	Ignore. Currently only used internally.
connection	Always provided	Specifies the device where the message is being played. Type is ConnectionID.
message	Always provided	Indicates the message that is being played. String contains Wave filename, but without the .wav suffix or the directory path. If this is "0", then an alphanumeric filename or a file list was specified in the request and the filename(s) will be in the extensions PlayMessagePrivateData object.
length	Always provided	The number of milliseconds of data to be played.
currentPosition	Always provided	The position in milliseconds from the beginning of the file that is currently being played. If playing is starting because of a PlayMessage request, then currentPosition is zero (0).
speed	Not supported
cause	Not supported
servicesPermitted	Not supported
extensions	Conditional	Both of these parameters in PlayMessagePrivateData are always provided: playMessage - current file being played fileList

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

PlayEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
EventCause	getCause() Returns the value of field 'cause'.
ConnectionID	getConnection() Returns the value of field 'connection'.
java.lang.Long	getCurrentPosition() Returns the value of field 'currentPosition'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.Long	getLength() Returns the value of field 'length'.
java.lang.String	getMessage() Returns the value of field 'message'.
java.lang.String	getMonitorCrossRefID() Returns the value of field 'monitorCrossRefID'.
java.lang.String	getResource() Returns the value of field 'resource'.
ServicesPermitted	getServicesPermitted() Returns the value of field 'servicesPermitted'.
java.lang.Long	getSpeed() Returns the value of field 'speed'.
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	setConnection(ConnectionID connection) Sets the value of field 'connection'.
void	setCurrentPosition(java.lang.Long currentPosition) Sets the value of field 'currentPosition'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setLength(java.lang.Long length) Sets the value of field 'length'.
void	setMessage(java.lang.String message) Sets the value of field 'message'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
void	setResource(java.lang.String resource) Sets the value of field 'resource'.
void	setServicesPermitted(ServicesPermitted servicesPermitted) Sets the value of field 'servicesPermitted'.
void	setSpeed(java.lang.Long speed) Sets the value of field 'speed'.
static PlayEvent	unmarshalPlayEvent(java.io.Reader reader) Method unmarshalPlayEvent
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

PlayEvent

public PlayEvent()

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

getConnection

public ConnectionID getConnection()

Returns the value of field 'connection'. The field 'connection' has the following description: Indicates the connection on which the message is being played. Mandatory.

Returns:

ConnectionID

getCurrentPosition

public java.lang.Long getCurrentPosition()

Returns the value of field 'currentPosition'. The field 'currentPosition' has the following description: Indicates the number of milliseconds from the start of the message. Always provided.

Returns:

Long

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getLength

public java.lang.Long getLength()

Returns the value of field 'length'. The field 'length' has the following description: Indicates the length of the message in milliseconds. Always provided.

Returns:

Long

getMessage

public java.lang.String getMessage()

Returns the value of field 'message'. The field 'message' has the following description: Indicates the message that is being played. Mandatory.

Returns:

String

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()

Returns the value of field 'monitorCrossRefID'.

Returns:

String

getResource

public java.lang.String getResource()

Returns the value of field 'resource'.

Returns:

String

getServicesPermitted

public ServicesPermitted getServicesPermitted()

Returns the value of field 'servicesPermitted'.

Returns:

ServicesPermitted

getSpeed

public java.lang.Long getSpeed()

Returns the value of field 'speed'. The field 'speed' has the following description: Indicates the current playing speed of the message (represents the percentage of normal speed, with 100% being normal speed and the slowest reportable speed being 1%). Optional. Not supported.

Returns:

Long

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

setConnection

public void setConnection(ConnectionID connection)

Sets the value of field 'connection'. The field 'connection' has the following description: Indicates the connection on which the message is being played. Mandatory.

Parameters:

connection - the value of field 'connection'.

setCurrentPosition

public void setCurrentPosition(java.lang.Long currentPosition)

Sets the value of field 'currentPosition'. The field 'currentPosition' has the following description: Indicates the number of milliseconds from the start of the message. Always provided.

Parameters:

currentPosition - the value of field 'currentPosition'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setLength

public void setLength(java.lang.Long length)

Sets the value of field 'length'. The field 'length' has the following description: Indicates the length of the message in milliseconds. Always provided.

Parameters:

length - the value of field 'length'.

setMessage

public void setMessage(java.lang.String message)

Sets the value of field 'message'. The field 'message' has the following description: Indicates the message that is being played. Mandatory.

Parameters:

message - the value of field 'message'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

setResource

public void setResource(java.lang.String resource)

Sets the value of field 'resource'.

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

setSpeed

public void setSpeed(java.lang.Long speed)

Sets the value of field 'speed'. The field 'speed' has the following description: Indicates the current playing speed of the message (represents the percentage of normal speed, with 100% being normal speed and the slowest reportable speed being 1%). Optional. Not supported.

Parameters:

speed - the value of field 'speed'.

unmarshalPlayEvent

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

Method unmarshalPlayEvent

Parameters:

reader -

Returns:

PlayEvent

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