com::pcbsys::nirvana::nAdminAPI::nCopyable Class Referenceabstract

All classes that can be copied from one part of the namespace to another implement this interface. More...

#include <nCopyable.h>

Inheritance diagram for com::pcbsys::nirvana::nAdminAPI::nCopyable:
com::pcbsys::nirvana::nAdminAPI::nLeafNode

Public Member Functions

virtual void copy (nNode *pToNode, std::string &toName, bool bWaitForCompletion, nACL *pAcl, nCommandStatus *pCmdStatus)=0
 This method enables the copy of the object from one node to another, specifying a name for the destination node, and whether the operation should wait until complete before returning. More...
 
virtual void copy (std::string &toName, bool bWaitForCompletion, nACL *pAcl, nCommandStatus *pCmdStatus)=0
 This method enables the copy of the object locally within the current node, specifying a name so there are no duplicates, and whether the operation should wait until complete before returning. More...
 
virtual void copy (nNode *pToNode, bool bWaitForCompletion, nChannelAttributes *pAttrib, nACL *pAcl, nCommandStatus *pCmdStatus)=0
 This method enables the copy of the object from one node to another, specifying a name for the destination node, and whether the operation should wait until complete before returning as well as specifying new channel attributes. More...
 
virtual void copy (bool bWaitForCompletion, nChannelAttributes *pAttrib, nACL *pAcl, nCommandStatus *pCmdStatus)=0
 This method enables the copy of the object locally within the current node, specifying a name so there are no duplicates, and whether the operation should wait until complete before returning, as well as specifying new channel attributes. More...
 

Detailed Description

All classes that can be copied from one part of the namespace to another implement this interface.

This facilitates manipulation of the nirvana namespace nodes.

Member Function Documentation

virtual void com::pcbsys::nirvana::nAdminAPI::nCopyable::copy ( nNode pToNode,
std::string &  toName,
bool  bWaitForCompletion,
nACL pAcl,
nCommandStatus pCmdStatus 
)
pure virtual

This method enables the copy of the object from one node to another, specifying a name for the destination node, and whether the operation should wait until complete before returning.

Parameters
*pToNodethe container node to copy this node to
toNamethe new name of the node to copy this node as.
bWaitForCompletiona boolean specifying whether the method should return immediately or after the command is completed.
*pAclan optional initial acl object that will be set on the object being copied
*pCmdStatusan optional nCommandStatus object so that you can query the status of the command whether waiting for completion or not (useful for progress bars etc.)
Deprecated:
As of version 2.0, please use copy(boolean p_waitForCompletion, nChannelAttributes p_attrib, nCommandStatus cmdStatus)
Exceptions
nUnsupportedCopyExceptionif the copy operation can not be performed with the parameters specified.

Implemented in com::pcbsys::nirvana::nAdminAPI::nLeafNode.

virtual void com::pcbsys::nirvana::nAdminAPI::nCopyable::copy ( std::string &  toName,
bool  bWaitForCompletion,
nACL pAcl,
nCommandStatus pCmdStatus 
)
pure virtual

This method enables the copy of the object locally within the current node, specifying a name so there are no duplicates, and whether the operation should wait until complete before returning.

Parameters
toNamethe new name of the node to copy this node as.
bWaitForCompletiona boolean specifying whether the method should return immediately or after the command is completed.
*pAclan optional initial acl object that will be set on the object being copied
*pCmdStatusan optional nCommandStatus object so that you can query the status of the command whether waiting for completion or not (useful for progress bars etc.)
Deprecated:
As of version 2.0, please use copy(boolean p_waitForCompletion, nChannelAttributes p_attrib, nCommandStatus cmdStatus)
Exceptions
nUnsupportedCopyExceptionif the copy operation can not be performed with the parameters specified.

Implemented in com::pcbsys::nirvana::nAdminAPI::nLeafNode.

virtual void com::pcbsys::nirvana::nAdminAPI::nCopyable::copy ( nNode pToNode,
bool  bWaitForCompletion,
nChannelAttributes pAttrib,
nACL pAcl,
nCommandStatus pCmdStatus 
)
pure virtual

This method enables the copy of the object from one node to another, specifying a name for the destination node, and whether the operation should wait until complete before returning as well as specifying new channel attributes.

Parameters
*pToNodethe name of the container node to copy this node to
bWaitForCompletiona boolean specifying whether the method should return immediately or after the command is completed.
*pAttribthe nChannelAttributes specifying the new nNode parameters (Name, Type, Capacity, TTL etc.)
See Also
com.pcbsys.nirvana.client.nChannelAttributes
Parameters
*pAclan optional initial acl object that will be set on the object being copied
*pCmdStatusan optional nCommandStatus object so that you can query the status of the command whether waiting for completion or not (useful for progress bars etc.)
Exceptions
nUnsupportedCopyExceptionif the copy operation can not be performed with the parameters specified.

Implemented in com::pcbsys::nirvana::nAdminAPI::nLeafNode.

virtual void com::pcbsys::nirvana::nAdminAPI::nCopyable::copy ( bool  bWaitForCompletion,
nChannelAttributes pAttrib,
nACL pAcl,
nCommandStatus pCmdStatus 
)
pure virtual

This method enables the copy of the object locally within the current node, specifying a name so there are no duplicates, and whether the operation should wait until complete before returning, as well as specifying new channel attributes.

Parameters
bWaitForCompletiona boolean specifying whether the method should return immediately or after the command is completed.
*pAttribthe nChannelAttributes specifying the new nNode parameters (Name, Type, Capacity, TTL etc.)
See Also
com.pcbsys.nirvana.client.nChannelAttributes
Parameters
*pAclan optional initial acl object that will be set on the object being copied
*pCmdStatusan optional nCommandStatus object so that you can query the status of the command whether waiting for completion or not (useful for progress bars etc.)
Exceptions
nUnsupportedCopyExceptionif the copy operation can not be performed with the parameters specified.

Implemented in com::pcbsys::nirvana::nAdminAPI::nLeafNode.