Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

CdbBdbObjectCloneUserAction Class Reference

The interface for user defined actions. More...

#include <CdbBdbObjectCloneUserAction.hh>

List of all members.

Public Types

enum  ActionType { ACTION_NEUTRAL, ACTION_COPIED, ACTION_ERROR }
 These values will be used to indicate the user's response. More...


Public Member Functions

virtual ~CdbBdbObjectCloneUserAction ()
 The destructor.

virtual ActionType action (const ooHandle(ooObj)&theInputH, ooHandle(ooObj)&theOutputH)=0
 Let a user to make a decision on what has to be done next.

Detailed Description

The interface for user defined actions.

This interface has to implemented by users willing to control the "deep copy" navigation in complex graphs.

IMPLEMENTATION NOTES:

(1) This class violates CDB API convention on the inclusion of "CdbBase/CdbCommon.hh" header file to avoid STD namespace conflicts of the kind described above.

Definition at line 22 of file CdbBdbObjectCloneUserAction.hh.

Member Enumeration Documentation

enum CdbBdbObjectCloneUserAction::ActionType
 

These values will be used to indicate the user's response.

Enumeration values:
ACTION_NEUTRAL 
ACTION_COPIED 
ACTION_ERROR 

Definition at line 28 of file CdbBdbObjectCloneUserAction.hh.

Constructor & Destructor Documentation

CdbBdbObjectCloneUserAction::~CdbBdbObjectCloneUserAction (    )  [virtual]
 

The destructor.

Moe details...

Definition at line 14 of file CdbBdbObjectCloneUserAction.cc.

Member Function Documentation

virtual ActionType CdbBdbObjectCloneUserAction::action (  const ooHandle(ooObj)&    theInputH,
ooHandle(ooObj)&    theOutputH
)  [pure virtual]
 

Let a user to make a decision on what has to be done next.

This method takes the "about-to-be-copied" link on the input. Ths link is evaluated and possibly processed by the method to produce the output link.

Here is the explanation of possible responses:

ACTION_NEUTRAL : user does not want to intervene into the calle. The output link does not change.

ACTION_COPIED : user has done the copy inside the procedure and provided a valid value for the output link. This tells the caller to use the output link set up by the method and do NOT propagate along this link.

ACTION_ERROR : an error has happened inside the method. Normally the caller should stop copying.

The documentation for this class was generated from the following files:
Generated on Mon Dec 5 18:22:18 2005 for CDB by doxygen1.3-rc3