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

CdbBdbHintProvider.hh

Go to the documentation of this file.
00001 #ifndef CDBBDB_HINT_PROVIDER_HH
00002 #define CDBBDB_HINT_PROVIDER_HH
00003 
00004 // File and Version Information:
00005 //      $Id: CdbBdbHintProvider.hh,v 1.2 2002/09/23 22:39:08 gapon Exp $
00006 
00007 #include "CdbBase/CdbCommon.hh"
00008 
00009 #include "BdbUtil/Bdb.hh"
00010 #include "BdbCond/BdbObject.hh"
00011 
00012 class BdbTime;
00013 
00014 /// This class defines a "hint provider" interface for the current technology
00015 /**
00016   * This interface has to be implemented through concrete implementations
00017   * of the current technology.
00018   */
00019 class CdbBdbHintProvider {
00020 
00021 public:
00022 
00023   /// The destructor.
00024   /**
00025     * Just to introduce the virtuality
00026     */
00027     virtual ~CdbBdbHintProvider( );
00028 
00029   /// Get the hint for specified parameters
00030   /**
00031     * This method if successfull (defined by the completions status) will set up
00032     * the value of the hint.
00033     *
00034     * @returns a completion status of the operation
00035     */
00036     virtual CdbStatus hint( BdbRefAny&     theHint,
00037                             const BdbTime& theBegin,
00038                             const BdbTime& theEnd ) = 0;
00039 
00040   /// Verify if created object matches the hint
00041   /**
00042     * @returns a completion status of the operation
00043     */
00044     virtual CdbStatus verify( const BdbRefAny&         theHint,
00045                               const BdbRef(BdbObject)& theObjectRef ) = 0;
00046 };
00047 
00048 #endif  // CDBBDB_HINT_PROVIDER_HH

Generated on Mon Dec 5 18:21:59 2005 for CDB by doxygen1.3-rc3