com.pcbsys.nirvana.nAdminAPI.nRemovable Interface Reference

All classes that can be removed from the namespace implement this interface. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nRemovable:
com.pcbsys.nirvana.nAdminAPI.nLeafNode com.pcbsys.nirvana.nAdminAPI.nLinkNode com.pcbsys.nirvana.nAdminAPI.nRealmNode com.pcbsys.nirvana.nAdminAPI.nScheduler

Public Member Functions

void remove (boolean removeChildren) throws nUnsupportedRemoveException, nNodeException
 This method enables the removal of the object from the namespace. More...
 

Detailed Description

All classes that can be removed from the namespace implement this interface.

This allows easy manipulation of the nirvana namespace objects that can be deleted

Member Function Documentation

void com.pcbsys.nirvana.nAdminAPI.nRemovable.remove ( boolean  removeChildren) throws nUnsupportedRemoveException, nNodeException

This method enables the removal of the object from the namespace.

If you specify true, all child nodes, including channels, queues will also be removed

Parameters
removeChildrena boolean specifying whether siblings should be removed too
Exceptions
nUnsupportedRemoveExceptionthrown if the remove operation is not supported on this node
nNodeExceptionis thrown if an error occurs in the remove operation
See Also
nLeafNode
nRealmNode
nLinkNode

Implemented in com.pcbsys.nirvana.nAdminAPI.nLeafNode, com.pcbsys.nirvana.nAdminAPI.nScheduler, and com.pcbsys.nirvana.nAdminAPI.nLinkNode.