ch.ecma.csta.binding
Class SuspendPlayEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Indicates that a message is suspended in play.

The SuspendPlayEvent can only be triggered by a Suspend request or SuspendPlaying request.

The parameters of the SuspendPlayEvent structure are:

SuspendPlayEvent Parameters
monitorCrossRefID	Not used	Ignore. Currently only used internally.
connection	Always provided	Specifies the device where the message is being suspended. 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. This will be in the extensions PlayMessagePrivateData object.
length	Always provided	The length of the played file in milliseconds. If a list of files was played, then this is the length of the last file that was played.
currentPosition	Always provided	The current position in milliseconds from the beginning of the last file that was played.
speed	Not supported
cause	Always provided	The reason for suspending the playing of the file is always EventCause.NORMAL.
servicesPermitted	Not supported
extensions	Always provided	A PlayMessagePrivateData object is embedded in extensions. The PlayMessagePrivateData fields that are provided are: playMessage - optional; provided if an alphanumeric filename was specified in the PlayMessage request. fileList - optional; provided if a list of filenames was specified in the PlayMessage request.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SuspendPlayEvent()

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'.
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'.
static SuspendPlayEvent	unmarshalSuspendPlayEvent(java.io.Reader reader) Method unmarshalSuspendPlayEvent
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

SuspendPlayEvent

public SuspendPlayEvent()

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 of the suspended message. 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. Optional.

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

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

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 of the suspended message. 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. Optional.

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

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

unmarshalSuspendPlayEvent

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

Method unmarshalSuspendPlayEvent

Parameters:

reader -

Returns:

SuspendPlayEvent

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