com.pcbsys.nirvana.nAdminAPI.nCopyable Interface Reference

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

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

Public Member Functions

void copy (nNode p_toNode, string p_toName, bool p_waitForCompletion, nACL acl, nCommandStatus cmdStatus)
 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...
 
void copy (string p_toName, bool p_waitForCompletion, nACL acl, nCommandStatus cmdStatus)
 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...
 
void copy (nNode p_toNode, bool p_waitForCompletion, nChannelAttributes p_attrib, nACL acl, nCommandStatus cmdStatus)
 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...
 
void copy (bool p_waitForCompletion, nChannelAttributes p_attrib, nACL acl, nCommandStatus cmdStatus)
 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

void com.pcbsys.nirvana.nAdminAPI.nCopyable.copy ( nNode  p_toNode,
string  p_toName,
bool  p_waitForCompletion,
nACL  acl,
nCommandStatus  cmdStatus 
)

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
p_toNodethe name of the container node to copy this node to
p_toNamethe new name of the node to copy this node as.
p_waitForCompletiona boolean specifying whether the method should return immediately or after the command is completed.
aclan optional initial acl object that will be set on the object being copied
cmdStatusan 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 1.

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

void com.pcbsys.nirvana.nAdminAPI.nCopyable.copy ( string  p_toName,
bool  p_waitForCompletion,
nACL  acl,
nCommandStatus  cmdStatus 
)

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
p_toNamethe new name of the node to copy this node as.
p_waitForCompletiona boolean specifying whether the method should return immediately or after the command is completed.
aclan optional initial acl object that will be set on the object being copied
cmdStatusan 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 2.

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

void com.pcbsys.nirvana.nAdminAPI.nCopyable.copy ( nNode  p_toNode,
bool  p_waitForCompletion,
nChannelAttributes  p_attrib,
nACL  acl,
nCommandStatus  cmdStatus 
)

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
p_toNodethe name of the container node to copy this node to
p_waitForCompletiona boolean specifying whether the method should return immediately or after the command is completed.
p_attribthe nChannelAttributes specifying the new nNode parameters

(Name, Type, Capacity, TTL etc) com.pcbsys.nirvana.client.nChannelAttributes

Parameters
aclan optional initial acl object that will be set on the object being copied
cmdStatusan 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 peformed with the parameters specified.

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

void com.pcbsys.nirvana.nAdminAPI.nCopyable.copy ( bool  p_waitForCompletion,
nChannelAttributes  p_attrib,
nACL  acl,
nCommandStatus  cmdStatus 
)

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
p_waitForCompletiona boolean specifying whether the method should return immediately or after the command is completed.
p_attribthe nChannelAttributes specifying the new nNode parameters

(Name, Type, Capacity, TTL etc) com.pcbsys.nirvana.client.nChannelAttributes

Parameters
aclan optional initial acl object that will be set on the object being copied
cmdStatusan 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 peformed with the parameters specified.

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