ch.ecma.csta.binding
Class Stop

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

All Implemented Interfaces:

java.io.Serializable

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

Stops playing or recording of a message and resets the position pointer to the beginning of the message.

The Stop request has these parameters:

Stop Request Parameters
connection	Mandatory	Specifies the device on which playing and recording is to be stopped. Only the device portion of the ConnectionID needs to be set.
messageToBeStopped	Not supported
extensions	Not supported

To avoid potential timing problems, you should request monitoring of the events generated by this request prior to sending the Stop request. If you do it after Stop request is sent, your application may or may not receive the appropriate event (the event may occur before).

The events that may be caused by a Stop request include:

• StopEvent

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: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

Stop()

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	getMessageToBeStopped() Returns the value of field 'messageToBeStopped'.
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	setMessageToBeStopped(java.lang.String messageToBeStopped) Sets the value of field 'messageToBeStopped'.
void	setResource(java.lang.String resource) Sets the value of field 'resource'.
static Stop	unmarshalStop(java.io.Reader reader) Method unmarshalStop
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

Stop

public Stop()

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 playing and recording is to be stopped. Only the device portion of the ConnectionID needs to be set. Mandatory.

Returns:

ConnectionID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getMessageToBeStopped

public java.lang.String getMessageToBeStopped()

Returns the value of field 'messageToBeStopped'. The field 'messageToBeStopped' has the following description: Not supported.

Specifies the message to be stopped. 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

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 playing and recording is to be stopped. Only the device portion of the ConnectionID needs to be set. 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'.

setMessageToBeStopped

public void setMessageToBeStopped(java.lang.String messageToBeStopped)

Sets the value of field 'messageToBeStopped'. The field 'messageToBeStopped' has the following description: Not supported.

Specifies the message to be stopped. 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:

messageToBeStopped - the value of field 'messageToBeStopped'.

setResource

public void setResource(java.lang.String resource)

Sets the value of field 'resource'.

Parameters:

resource - the value of field 'resource'.

unmarshalStop

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

Method unmarshalStop

Parameters:

reader -

Returns:

Stop

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