ch.ecma.csta.binding
Class Review

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

All Implemented Interfaces:

java.io.Serializable

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

This request is not supported.

Plays a portion of a voice message during a recording session, until either the end of the portion is reached or a Suspend service request is issued. When this service completes, the position reached becomes the value of the position pointer. This service does not affect the current position unless a suspend occurs before the review completes.

Refer to ECMA-269, Figure 6-21, "Voice Unit Operational Model" in section 6.2.1 for the operational model.

The monitoring event sequence is a ReviewEvent for both device-type and call-type monitoring.

CSTA Functional Requirements:

1. The Review service cannot be issued while the Voice Unit is already in the Review state.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Review()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
ConnectionID	getConnection() Returns the value of field 'connection'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getMessageToReview() Returns the value of field 'messageToReview'.
PeriodToReview	getPeriodToReview() Returns the value of field 'periodToReview'.
java.lang.String	getResource() Returns the value of field 'resource'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setConnection(ConnectionID connection) Sets the value of field 'connection'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setMessageToReview(java.lang.String messageToReview) Sets the value of field 'messageToReview'.
void	setPeriodToReview(PeriodToReview periodToReview) Sets the value of field 'periodToReview'.
void	setResource(java.lang.String resource) Sets the value of field 'resource'.
static Review	unmarshalReview(java.io.Reader reader) Method unmarshalReview
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

Review

public Review()

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

getConnection

public ConnectionID getConnection()

Returns the value of field 'connection'. The field 'connection' has the following description: Specifies the connection on which the message is to be reviewed. Mandatory.

Returns:

ConnectionID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getMessageToReview

public java.lang.String getMessageToReview()

Returns the value of field 'messageToReview'. The field 'messageToReview' has the following description: Specifies the message to be reviewed. This parameter is mandatory if there are multiple active messages on the specified connection, otherwise the parameter is optional.

If this parameter is not provided, the service applies to the currently active message on the specified connection.

Returns:

String

getPeriodToReview

public PeriodToReview getPeriodToReview()

Returns the value of field 'periodToReview'. The field 'periodToReview' has the following description: Specifies the length of the message to be reviewed. Mandatory.

This will be one of the following choices:

• start of message - specifies that the message will be reviewed from the beginning of the message.
• length of review (Value) - specifies the length in milliseconds that the message pointer should be moved towards the beginning of the message before being reviewed.

Returns:

PeriodToReview

getResource

public java.lang.String getResource()

Returns the value of field 'resource'.

Returns:

String

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

setConnection

public void setConnection(ConnectionID connection)

Sets the value of field 'connection'. The field 'connection' has the following description: Specifies the connection on which the message is to be reviewed. Mandatory.

Parameters:

connection - the value of field 'connection'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setMessageToReview

public void setMessageToReview(java.lang.String messageToReview)

Sets the value of field 'messageToReview'. The field 'messageToReview' has the following description: Specifies the message to be reviewed. This parameter is mandatory if there are multiple active messages on the specified connection, otherwise the parameter is optional.

If this parameter is not provided, the service applies to the currently active message on the specified connection.

Parameters:

messageToReview - the value of field 'messageToReview'.

setPeriodToReview

public void setPeriodToReview(PeriodToReview periodToReview)

Sets the value of field 'periodToReview'. The field 'periodToReview' has the following description: Specifies the length of the message to be reviewed. Mandatory.

This will be one of the following choices:

• start of message - specifies that the message will be reviewed from the beginning of the message.
• length of review (Value) - specifies the length in milliseconds that the message pointer should be moved towards the beginning of the message before being reviewed.

Parameters:

periodToReview - the value of field 'periodToReview'.

setResource

public void setResource(java.lang.String resource)

Sets the value of field 'resource'.

Parameters:

resource - the value of field 'resource'.

unmarshalReview

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

Method unmarshalReview

Parameters:

reader -

Returns:

Review

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