com.highdeal.catalog.hci
Class DeleteCatalogOp

java.lang.Object
  com.highdeal.catalog.hci.DeleteCatalogOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class DeleteCatalogOp
extends java.lang.Object
implements MessageOperation

This class represents a catalog entry deletion. It deletes the specified catalog entry and all its children.

See Also :

DeleteCatalogResult

Operation Failure Exception :

InvalidDeletionException

XML Schema Fragment

<xs:element name="deleteCatalog">
   <xs:complexType>
     <xs:attribute name="ref" type="xs:string"/>
   </xs:complexType>
 </xs:element>

Operation availability :

Edition	Available On:
	Rater	Updater	Backup	Guider	Charger	BulkLoader	BillingAssistant	EZTaxer
Rate	no	yes	no	no	no	no	no	no
Charge	no	yes	no	no	no	no	no	no
Bill	no	yes	no	no	no	no	no	no
Full	no	yes	no	no	no	no	no	no

Field Summary

static java.lang.String

OPERATION_NAME

Constructor Summary

DeleteCatalogOp()

Method Summary

void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the objects, the child represents the marshallable object to be added into the content tree.
java.lang.String	getEntryRef() Gets the reference of the entry to be deleted.
java.lang.String	getName() Gets the name of the operation.
void	marshal(XMLOutputter output) Gives an XML representation of this object, and of its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the tag beeing processed.
void	setEntryRef(java.lang.String ref) Sets the reference of the entry to be deleted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

See Also:

Constant Field Values

Constructor Detail

DeleteCatalogOp

public DeleteCatalogOp()

Method Detail

getName

public java.lang.String getName()

Gets the name of the operation.

Specified by:

getName in interface MessageOperation

Returns:

"deleteCatalog"

getEntryRef

public java.lang.String getEntryRef()

Gets the reference of the entry to be deleted.

Returns:

the reference of the entry to be deleted.

setEntryRef

public void setEntryRef(java.lang.String ref)

Sets the reference of the entry to be deleted.

Parameters:

ref - the reference of the entry to be deleted.

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the tag beeing processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - the XML attributes of the current tag.

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - the character data to be added.

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the objects, the child represents the marshallable object to be added into the content tree.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - the name of tag for the child.

child - the child to be added.

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, and of its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - the XML output to marshall the object into.