ch.ecma.csta.binding
Class StopEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Indicates that a message play or record operation on a connection has been stopped.

The Stop Event could be caused by any of the following:

• A DTMF digit was detected during a play or record operation.
• The end of the message was detected during a play or record operation.
• The maximum permitted time duration for a play or record operation was detected.
• The maximum permitted size of the message was detected during a recording operation.
• A message has stopped playing or recording (a more specific cause cannot be provided).
• A period of silence was detected during a record operation.
• Speech (or non-silence) was detected while a message was playing.
• A play or record stopped normally based on the requested terminating conditions.
• A play or record stopped due to a
  • Stop request
  • StopPlaying request
  • StopRecording request
• The device has become unregistered.

When performing multiple record operations with Stop requests, a Stop Event from an earlier Stop request may occur after subsequent record operations. This means a Stop Event may be associated with an earlier record operation rather than the most recent record operation.

The parameters of the StopEvent structure are:

StopEvent Parameters
monitorCrossRefID	Not used	Ignore. Currently only used internally.
connection	Always provided	Specifies the device where the message is being stopped. Type is ConnectionID.
message	Always provided	Indicates the message that is being recorded. The message is either a numeric Wave filename without the .wav suffix and directory or "0". If this is "0", then an alphanumeric Wave filename was specified in the request. This is also the case if a file list was specified in the play request. The alphanumeric name or list will be in the extensions PlayMessagePrivateData or the RecordMessagePrivateData request.
length	Always provided	The length of the recorded or 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 played or recorded file.
cause	Always provided	The reason for stopping the playing or recording of the file. This can be NORMAL, DTMFDIGITDETECTED or DURATIONEXCEEDED.
servicesPermitted	Not supported
extensions	Always provided	This is either a PlayMessagePrivateData or a RecordMessagePrivateData object. 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. The RecordMessagePrivateData fields that are provided are: filename - always provided timestamp - always provided

Avaya specifies the following private data when the StopEvent is indicating that recording has stopped:

RecordMessagePrivateData Parameters
filename	Always provided	The alphanumeric filename specified in the request.
timestamp	Always provided	The stop time of the recording.

Alternatively, if the StopEvent is indicating that playing has stopped, then the following private data is in the extensions parameter:

PlayMessagePrivateData Parameters
playMessage	Optional	The alphanumeric filename specified in the request.
fileList	Optional	The the list of filenames that was specified in the request.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

StopEvent()

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 StopEvent	unmarshalStopEvent(java.io.Reader reader) Method unmarshalStopEvent
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

StopEvent

public StopEvent()

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

unmarshalStopEvent

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

Method unmarshalStopEvent

Parameters:

reader -

Returns:

StopEvent

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