---

CdbBdbPrintObjectTreeUserAction.hh

Go to the documentation of this file.

#ifndef CDBBDB_PRINT_OBJECT_TREE_USER_ACTION_HH
#define CDBBDB_PRINT_OBJECT_TREE_USER_ACTION_HH

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

#include "CdbBase/CdbCommon.hh"

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

/// The base class for user defined actions
/**
  * This base class has to implemented by users willing to control
  * the "print object children" 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 CdbBdbPrintObjectTreeUserAction {

public:

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

    typedef enum { ACTION_PROCEED,
                   ACTION_STOP,
                   ACTION_ERROR } ActionType;

public:

  /// The constructor
  /**
    * Inityialize's the object's parameters.
    */
    CdbBdbPrintObjectTreeUserAction( bool verboseMode = false,
                                     bool debugMode   = false );

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

  /// Let a user to make a decision on what has to be done next
  /**
    * This wrapper method takes the "about-to-be-printed" link on the input. Ths link
    * is evaluated by the method to report what's the next action should be.
    *
    * The second parameter passed town to the operation is the current context
    * description in which the link has to be evaluated.
    *
    * Here is the explanation of possible responses:
    *
    *   ACTION_PROCEED : a caller has to proceed and print this node.
    *
    *   ACTION_STOP    : a caller should stop and not to propagate along this link.
    *
    *   ACTION_ERROR   : an error has happened inside the method. Normally the caller
    *                    should stop printing any further links.
    *
    * HOW IT WORKS:
    *
    *   - first of all this method will verify if the passed object is valid and return
    *     the ACTION_ERROR value if it's not.
    *
    *   - if the passed object is valid then a user defined "userAction"
    *     application's object will be called to let a user to proceed with his/her
    *     actions in the passed object's context.
    *
    * @see CdbBdbPrintObjectTreeUserAction::userAction()
    */
    ActionType action( const ooHandle(ooObj)& theInputH );

protected:

  /// Let a user to make a decision on what has to be done next (ACTUAL USER ACTION)
  /**
    * This method gets called only for valid objects.
    *
    * IMPLEMENTATION NOTE: In its default implementation this method would always
    *                      return ACTION_PROCEED. This behaviour can be overriten
    *                      by specific subclasses.
    *
    * @see CdbBdbPrintObjectTreeUserAction::action()
    */
    virtual ActionType userAction( const ooHandle(ooObj)& theInputH );

private:

  // Parameters

    bool _verboseMode;
    bool _debugMode;
};

#endif  // CDBBDB_PRINT_OBJECT_TREE_USER_ACTION_HH

---