---

CdbBdbObjectCloneUserAction.hh

Go to the documentation of this file.

#ifndef CDBBDB_OBJECT_CLONE_USER_ACTION_HH
#define CDBBDB_OBJECT_CLONE_USER_ACTION_HH

// File and Version Information:
//      $Id: CdbBdbObjectCloneUserAction.hh,v 1.2 2004/10/21 20:35:49 gapon Exp $

#include "CdbBase/CdbCommon.hh"

#include <oo.h>     // ooRef(ooObj), ooHandle(ooObj)

/// 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.
  */
class CdbBdbObjectCloneUserAction {

public:

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

    typedef enum { ACTION_NEUTRAL,
                   ACTION_COPIED,
                   ACTION_ERROR } ActionType;

public:

  /// The destructor
  /**
    * Moe details...
    */
    virtual ~CdbBdbObjectCloneUserAction( );

  /// 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.
    */
    virtual ActionType action( const ooHandle(ooObj)& theInputH,
                                     ooHandle(ooObj)& theOutputH ) = 0;
};

#endif  // CDBBDB_OBJECT_CLONE_USER_ACTION_HH

---