ch.ecma.csta.binding
Class RecordEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Indicates that a message is being recorded.

The RecordEvent occurs as a result of:

• RecordMessage
• Resume
• ResumeRecording

The parameters of the RecordEvent structure are:

RecordEvent Parameters
monitorCrossRefID	Not used	Ignore. Currently only used internally.
connection	Always provided	Specifies the device where the message is being recorded. 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 RecordMessage request and can be found in the extensions RecordMessagePrivateData object.
length	Always provided	The length of the recording thus far in milliseconds.
currentPosition	Always provided	The current position in milliseconds from the beginning of the recorded file. Same value as length.
cause	Always provided.	Always set to EventCause.NORMAL.
servicesPermitted	Not supported
extensions	Always provided	These parameters in RecordMessagePrivateData are always provided: filename timestamp

Avaya specifies the following private data for RecordEvent's extensions parameter:

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

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

RecordEvent()

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

RecordEvent

public RecordEvent()

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 recorded. 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 recorded. 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 on which the message is being recorded. 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 recorded. 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'.

unmarshalRecordEvent

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

Method unmarshalRecordEvent

Parameters:

reader -

Returns:

RecordEvent

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