ch.ecma.csta.binding
Class DeleteMessage

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

All Implemented Interfaces:

java.io.Serializable

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

Deletes a specified voice message.

The DeleteMessage request has these parameters:

DeleteMessage Request Parameters
messageToBeDeleted	Mandatory	Specifies a numeric filename of the message to be deleted. Exclude the ".wav" suffix. Neither a full directory path nor a subpath can be included with the filename. To specify an alphanumeric filename or a relative path with the filename, set messageToBeDeleted to "0" and specify the filename in the extensions parameter's DeleteMessagePrivateData.
extensions	Conditional	Optional parameters can be set in this parameter's CSTACommonArguments private data area. The parameters that can be set are: filename - Conditional. An alphanumeric filename of a message to be deleted. Include any suffix in the name.

Negative Acknowledgements:

• operation:invalidParameterValue - Sent if an invalid parameter is passed.
• operation:invalidFile - Sent if unable to find the file.
• 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.
• unspecified - Sent if an implementation-specific error occurs.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

DeleteMessage()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getMessageToBeDeleted() Returns the value of field 'messageToBeDeleted'.
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	setMessageToBeDeleted(java.lang.String messageToBeDeleted) Sets the value of field 'messageToBeDeleted'.
static DeleteMessage	unmarshalDeleteMessage(java.io.Reader reader) Method unmarshalDeleteMessage
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

DeleteMessage

public DeleteMessage()

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

getMessageToBeDeleted

public java.lang.String getMessageToBeDeleted()

Returns the value of field 'messageToBeDeleted'. The field 'messageToBeDeleted' has the following description: Specifies the message to be deleted. Mandatory.

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

setMessageToBeDeleted

public void setMessageToBeDeleted(java.lang.String messageToBeDeleted)

Sets the value of field 'messageToBeDeleted'. The field 'messageToBeDeleted' has the following description: Specifies the message to be deleted. Mandatory.

Parameters:

messageToBeDeleted - the value of field 'messageToBeDeleted'.

unmarshalDeleteMessage

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

Method unmarshalDeleteMessage

Parameters:

reader -

Returns:

DeleteMessage

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