---

CdbSQLApi.hh

Go to the documentation of this file.

#ifndef CDBSQL_API_HH
#define CDBSQL_API_HH

// File and Version Information:
//      $Id: CdbSQLApi.hh,v 1.2 2005/09/15 05:15:31 gapon Exp $

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

class BdbTime;

class CdbObjectFactoryBase;
class CdbSQLObjectId;
class CdbSQLCondition;
class CdbSQLPartition;

/// The starting point for the public API of the Conditions/DB.
/**
  * The only reason to have this abtsract class in the hierarchy is that it provides
  * the "::createObject()" meant to deffer an actual object creation sequence by a subclass
  * down the hierarchy. That allows final implementations of the current API class
  * to instantiate objects (those produced by the above mentioned method) of correct types.
  *
  * A general idea is that we have enough data at the current level to create new objects
  * but we don't know types of that objects.
  *
  *   NOTE: A similar idea would be to define a method delivering a factory interface.
  *         This could even work at a higher level of this class's hierarchy (class Cdb).
  *
  * @see CdbSQLApi::createObject()
  * @see Cdb
  * @see CdbEnvironment
  */
class CdbSQLApi : public Cdb {

private:

  /// The copy constructor (NOT IMPLEMENTED)
  /**
    * Is disabled...
    */
    CdbSQLApi( const CdbSQLApi& );

  /// The assignment operator (NOT IMPLEMENTED)
  /**
    * Is disabled...
    */
    CdbSQLApi& operator=( const CdbSQLApi& );

protected:

  /// The default constructor.
  /**
    * The c-tor is only availble to subclasses.
    */
    CdbSQLApi( );

public:

  /// The destructor
  /**
    * More details...
    */
    virtual ~CdbSQLApi( );

  /// Create a metadata object of a right type
  /**
    * This method is meant to defer the actual operation to a more specialized
    * implementation of the current class. This way we let that (specialized)
    * implementation to decide on an object type.
    *
    * The method is supposed to be implemented by a subclass.
    *
    * @see CdbObject
    * @see CdbCondition
    * @see CdbSQLObjectId
    *
    * @return CdbStatus::Success if the operation succeeds
    */
    virtual CdbStatus createObject( CdbObjectPtr&          theObjectPtr,
                                    const CdbConditionPtr& theParentConditionPtr,
                                    const BdbTime&         theOriginalValidityBeginTime,
                                    const BdbTime&         theOriginalValidityEndTime,
                                    const BdbTime&         theVisibleValidityBeginTime,
                                    const BdbTime&         theVisibleValidityEndTime,
                                    const BdbTime&         theDurationBeginTime,
                                    const BdbTime&         theDurationEndTime,
                                    const BdbTime&         theInsertionTime,
                                    const CdbSQLObjectId&  theObjectId
                                  ) = 0;

  /// Create a persistent object (in the specified context) and store it in a database
  /**
    * This method is meant to defer the actual operation to a more specialized
    * implementation of the current class. This way we let that (specialized)
    * implementation to decide on an object type.
    *
    * The method is supposed to be implemented by a subclass.
    *
    * @see CdbObject
    * @see CdbCondition
    *
    * @return CdbStatus::Success if the operation succeeds
    */
    virtual CdbStatus storeObject( CdbObjectPtr&             theObjectPtr,
                                   CdbObjectFactoryBase&     theObjectFactory,
                                   CdbCPtr<CdbSQLCondition>& thePersistentConditionPtr,
                                   CdbCPtr<CdbSQLPartition>& thePersistentPartitionPtr,
                                   const CdbConditionPtr&    theParentConditionPtr,
                                   const BdbTime&            theOriginalValidityBeginTime,
                                   const BdbTime&            theOriginalValidityEndTime
                                  ) = 0;
};

#endif  // CDBSQL_API_HH

---