ICollectionService.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef COLLECTIONBASE_ICOLLECTIONSERVICE_H
#define COLLECTIONBASE_ICOLLECTIONSERVICE_H
 
#include "CollectionBase/ICollection.h"
#include "CxxUtils/checker_macros.h"
 
#include <string>
 
 
namespace pool {
 
  class ICollectionDescription;
  class ISession;
  class ICollectionCursor;
  class IFileCatalog;
 
  class ATLAS_NOT_THREAD_SAFE ICollectionService
  {
  public:
    virtual ICollection* create( const ICollectionDescription& description,
                                 bool overwrite = false ) = 0;
 
    virtual ICollection* createAndRegister( const ICollectionDescription& description,
                                            bool overwrite = false,
                                            const std::string & logicalName = "" ) = 0;
 
    virtual bool registerExisting( const std::string & name,
                                   const std::string & type,
                                   const std::string & connection = "",
                                   const std::string & logicalName = "" ) = 0;
 
 
    virtual bool registerExisting( ICollection* collection,
                   bool overwrite = false,
                                   const std::string & logicalName = "" ) = 0;
 
 
    virtual ICollection* handle( const std::string& name,
                                 const std::string& type,
                                 const std::string & connection = "",
                                 bool readOnly = true,
                                 ISession* session = 0 ) const = 0;
 
    virtual ICollection* openWithPhysicalName( const std::string& physicalName,
                                               pool::ICollection::OpenMode openMode = pool::ICollection::READ ) = 0;
 
    virtual ICollection* openWithLogicalName( const std::string& logicalName, 
                                              bool readOnly = true ) = 0;
                    
    virtual ICollection* openWithGuid( const std::string& guid,
                                       bool readOnly = true ) = 0;
 
    virtual bool setDefaultCatalog() = 0;
 
    virtual bool setWriteCatalog( const std::string& name ) = 0;
 
    virtual bool addReadCatalog( const std::string& name ) = 0;
 
    virtual IFileCatalog* getCatalog( ) = 0;
 
    virtual void setCatalog( IFileCatalog* collCat ) = 0;
 
  protected:
    virtual ~ICollectionService() {}
  };
 
}
 
#endif