ch.ecma.csta.binding
Class Resume

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

All Implemented Interfaces:

java.io.Serializable

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

Restarts the playing or recording of a previously suspended message at its current position.

The Record request has these parameters:

Resume Request Parameters
connection	Required	Specifies the device on which the message is to be resumed (only the deviceID field of the connectionID is used).
messageToResume	Not supported
duration	Not supported
extensions	Not supported

The following events are generated as a result of this service:

• PlayEvent
• RecordEvent

CSTA Functional Requirements have been implemented as follows:

• CSTA Reposition service is not yet supported, therefore the position pointer can not be manipulated.

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

Negative Acknowledgements:

• operation:invalidParameterValue - Sent if an invalid parameter is passed.
• operation:invalidConnectionID - Sent if unable to find the Media Session associated with the DeviceID of this request.
• operation:invalidMsgID - Sent if the specified messageID is invalid or if the File (messageID) is not found.
• operation:messageIDRequired - Sent if messageID is null.
• operation:generic - Sent if an IOError occurred or if a channel is already closed.
• systemResourceAvailability:generic - Sent if a severe system error like un-availability of a system wide resource.
• stateIncompatibility:invalidObjectState - Sent if the player or recorder is in an invalid state.
• unspecified - Sent if an implementation-specific error occurs.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Resume()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
ConnectionID	getConnection() Returns the value of field 'connection'.
java.lang.Long	getDuration() Returns the value of field 'duration'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getMessageToResume() Returns the value of field 'messageToResume'.
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	setDuration(java.lang.Long duration) Sets the value of field 'duration'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setMessageToResume(java.lang.String messageToResume) Sets the value of field 'messageToResume'.
void	setResource(java.lang.String resource) Sets the value of field 'resource'.
static Resume	unmarshalResume(java.io.Reader reader) Method unmarshalResume
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

Resume

public Resume()

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 device on which the message is to be resumed. Mandatory.

Returns:

ConnectionID

getDuration

public java.lang.Long getDuration()

Returns the value of field 'duration'. The field 'duration' has the following description: Not supported. Specifies the length of time for playback or recording (in milliseconds). Optional.

Returns:

Long

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getMessageToResume

public java.lang.String getMessageToResume()

Returns the value of field 'messageToResume'. The field 'messageToResume' has the following description: Not supported. Specifies the message to be resumed. This parameter is mandatory if there are multiple suspended messages on the specified connection, otherwise the parameter is optional. If this parameter is not provided, the service applies to the currently suspended message on the specified connection.

Returns:

String

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 device on which the message is to be resumed. Mandatory.

Parameters:

connection - the value of field 'connection'.

setDuration

public void setDuration(java.lang.Long duration)

Sets the value of field 'duration'. The field 'duration' has the following description: Not supported. Specifies the length of time for playback or recording (in milliseconds). Optional.

Parameters:

duration - the value of field 'duration'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setMessageToResume

public void setMessageToResume(java.lang.String messageToResume)

Sets the value of field 'messageToResume'. The field 'messageToResume' has the following description: Not supported. Specifies the message to be resumed. This parameter is mandatory if there are multiple suspended messages on the specified connection, otherwise the parameter is optional. If this parameter is not provided, the service applies to the currently suspended message on the specified connection.

Parameters:

messageToResume - the value of field 'messageToResume'.

setResource

public void setResource(java.lang.String resource)

Sets the value of field 'resource'.

Parameters:

resource - the value of field 'resource'.

unmarshalResume

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

Method unmarshalResume

Parameters:

reader -

Returns:

Resume

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