---

CdbBdbObjectCreator.hh

Go to the documentation of this file.

#ifndef CDBBDB_OBJECT_CREATOR_HH
#define CDBBDB_OBJECT_CREATOR_HH

// File and Version Information:
//      $Id: CdbBdbObjectCreator.hh,v 1.3 2005/09/15 05:06:26 gapon Exp $

#include "CdbBase/CdbObjectPtrFwd.hh"
#include "CdbBase/CdbConditionPtrFwd.hh"

#include "BdbCond/BdbObject.hh"

class BdbTime;

/// This is a trait class for creating objects
/**
  * This trait class provides object hint/creation/verification services to CDB API
  * implementaions related to the current persistent technology.
  *
  * The interface defines the following operations:
  *
  * - providing a clustering hint object in specified context;
  * - constructing an object of a concrete subclass of the CdbObject class
  *   for specified parameters (including a persistent object).
  */
class CdbBdbObjectCreator {

public:

  /// Provide a placement hint in specified context
  /**
    * This operation may involves interactions with a database.
    *
    * @see CdbCondition
    * @see CdbConditionPtr
    * @see BdbTime
    * @see CdbStatus
    */
    static CdbStatus hint( BdbRefAny&             theHint,          /**< a reference to the hint to be initialized */
                           const CdbConditionPtr& theConditionPtr,  /**< a smart pointer onto a condition's API */
                           const BdbTime&         theBegin,         /**< a point where the object's validity begins from */
                           const BdbTime&         theEnd            /**< ... and finishes (exclusing) at */
                         );

  /// Verify if specified placement hint and persistent objects match each other
  /**
    * This operation is meant to verify of specified persistent object was
    * properly created in the place suggested by the hint.
    *
    * This operation may involves interactions with a database.
    *
    * @see CdbStatus
    */
    static CdbStatus verify( const BdbRefAny&            theHint,           /**< a reference to the hint */
                             const BdbHandle(BdbObject)& thePersObj,        /**< a reference onto a persistent object */
                             const CdbConditionPtr&      theConditionPtr    /**< a smart pointer onto a condition's API */
                           );

  /// Build an object of a concrete class from specified parameters
  /**
    * This operation may involves interactions with a database.
    *
    * @see CdbCondition
    * @see CdbConditionPtr
    * @see CdbObject
    * @see CdbObjectPtr
    * @see BdbTime
    * @see CdbStatus
    */
    static CdbStatus object( CdbObjectPtr&          theObjectPtr,               /**< a smart pointer onto an object to be created */
                             const CdbConditionPtr& theConditionPtr,            /**< a smart pointer onto a condition's API */
                             const BdbTime&         theBeginOriginalValidity,   /**< a point where the object's 'original' validity begins from */
                             const BdbTime&         theEndOriginalValidity,     /**< ... and finishes (exclusing) at */
                             const BdbTime&         theBeginValidity,           /**< a point where the object's 'visible' validity begins from */
                             const BdbTime&         theEndValidity,             /**< ... and finishes (exclusing) at */
                             const BdbTime&         theBeginDuration,           /**< a point where the object's duration at insertin time begins from */
                             const BdbTime&         theEndDuration,             /**< ... and finishes (exclusing) at */
                             const BdbTime&         theInsertionTime,           /**< the time when a new object was created */
                             const BdbHandle(BdbObject)& thePersObj             /**< a reference onto a persistent object */
                           );
};

#endif  // CDBBDB_OBJECT_CREATOR_HH

---