ch.ecma.csta.binding
Class Reposition

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

All Implemented Interfaces:

java.io.Serializable

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

This request is not supported.

Moves the current position pointer forward or backward a specified number of milliseconds in a message. This service also allows the position pointer to be set to the start or to the end of the message.

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

CSTA Functional Requirements:

1. Moving forward and backward within the indicated message on the indicated connection is accomplished by using positive or negative values for the period, respectively.
2. An attempt to move backward beyond the beginning of a message moves to the start of the message. An attempt to move forward beyond the end of the message moves to the end of the message.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Reposition()

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	getMessageToReposition() Returns the value of field 'messageToReposition'.
Period	getPeriodOfReposition() Returns the value of field 'periodOfReposition'.
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	setMessageToReposition(java.lang.String messageToReposition) Sets the value of field 'messageToReposition'.
void	setPeriodOfReposition(Period periodOfReposition) Sets the value of field 'periodOfReposition'.
void	setResource(java.lang.String resource) Sets the value of field 'resource'.
static Reposition	unmarshalReposition(java.io.Reader reader) Method unmarshalReposition
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

Reposition

public Reposition()

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 repositioned. Mandatory.

Returns:

ConnectionID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getMessageToReposition

public java.lang.String getMessageToReposition()

Returns the value of field 'messageToReposition'. The field 'messageToReposition' has the following description: Specifies the message whose pointer is to be repositioned. 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

getPeriodOfReposition

public Period getPeriodOfReposition()

Returns the value of field 'periodOfReposition'. The field 'periodOfReposition' has the following description: Specifies how the pointer should be repositioned. Mandatory.

This will be one of the following choices:

• start of message
• end of message
• relative position from current pointer (Value) - a positive value moves the message pointer forward (toward the end of the message), a negative value moves the message pointer backward (towards the beginning of the message).

Returns:

Period

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

setMessageToReposition

public void setMessageToReposition(java.lang.String messageToReposition)

Sets the value of field 'messageToReposition'. The field 'messageToReposition' has the following description: Specifies the message whose pointer is to be repositioned. 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:

messageToReposition - the value of field 'messageToReposition'.

setPeriodOfReposition

public void setPeriodOfReposition(Period periodOfReposition)

Sets the value of field 'periodOfReposition'. The field 'periodOfReposition' has the following description: Specifies how the pointer should be repositioned. Mandatory.

This will be one of the following choices:

• start of message
• end of message
• relative position from current pointer (Value) - a positive value moves the message pointer forward (toward the end of the message), a negative value moves the message pointer backward (towards the beginning of the message).

Parameters:

periodOfReposition - the value of field 'periodOfReposition'.

setResource

public void setResource(java.lang.String resource)

Sets the value of field 'resource'.

Parameters:

resource - the value of field 'resource'.

unmarshalReposition

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

Method unmarshalReposition

Parameters:

reader -

Returns:

Reposition

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