ch.ecma.csta.binding
Class Clear

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

All Implemented Interfaces:

java.io.Serializable

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

Not supported.

Halts operations and releases any data held by a Listener, DTMF or Prompt Queue.

For an illustration of this service, see ECMA 269, section 26.1.2.

Connection State Transitions:

• There are no connection state changes due to this service.
• For Interactive Voice Devices refer to for normactive resource state transitions specified, see ECMA 269 Figure 6-17, Figure 6-18, and Figure 6-19 in Clause 6.1.1.4.8, "Generic Interactive Voice Device Category".

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

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Clear()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
ConnectionID	getOverConnection() Returns the value of field 'overConnection'.
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	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setOverConnection(ConnectionID overConnection) Sets the value of field 'overConnection'.
void	setResource(java.lang.String resource) Sets the value of field 'resource'.
static Clear	unmarshalClear(java.io.Reader reader) Method unmarshalClear
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

Clear

public Clear()

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

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getOverConnection

public ConnectionID getOverConnection()

Returns the value of field 'overConnection'. The field 'overConnection' has the following description:

Specifies the connection for which the operations and data held by a Listener, DTMF, or a Prompt Queue is to be cleared.

Returns:

ConnectionID

getResource

public java.lang.String getResource()

Returns the value of field 'resource'. The field 'resource' has the following description:

Specifies the interactive voice resource for this service. This parameter is required if there are multiple interactive voice resource per connection.

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

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setOverConnection

public void setOverConnection(ConnectionID overConnection)

Sets the value of field 'overConnection'. The field 'overConnection' has the following description:

Specifies the connection for which the operations and data held by a Listener, DTMF, or a Prompt Queue is to be cleared.

Parameters:

overConnection - the value of field 'overConnection'.

setResource

public void setResource(java.lang.String resource)

Sets the value of field 'resource'. The field 'resource' has the following description:

Specifies the interactive voice resource for this service. This parameter is required if there are multiple interactive voice resource per connection.

Parameters:

resource - the value of field 'resource'.

unmarshalClear

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

Method unmarshalClear

Parameters:

reader -

Returns:

Clear

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