IDataProviderSvc.h

Go to the documentation of this file.

#ifndef GAUDIKERNEL_IDATAPROVIDERSVC_H
#define GAUDIKERNEL_IDATAPROVIDERSVC_H

// Framework include files
#include "GaudiKernel/IInterface.h"

// C/C++ include files
#include "boost/utility/string_ref.hpp"
#include <string>

// Forward declarations
class DataObject;
class IOpaqueAddress;
class IRegistry;
class DataStoreItem;

class GAUDI_API IDataProviderSvc : virtual public IInterface
{
public:
  DeclareInterfaceID( IDataProviderSvc, 4, 0 );

  enum { SEPARATOR = '/' };

  virtual StatusCode registerObject( boost::string_ref fullPath, DataObject* pObject ) = 0;

  virtual StatusCode registerObject( boost::string_ref parentPath, boost::string_ref objectPath,
                                     DataObject* pObject ) = 0;

  virtual StatusCode registerObject( boost::string_ref parentPath, int item, DataObject* pObject ) = 0;

  virtual StatusCode registerObject( DataObject* parentObj, boost::string_ref objectPath, DataObject* pObject ) = 0;

  virtual StatusCode registerObject( DataObject* parentObj, int item, DataObject* pObject ) = 0;

  virtual StatusCode unregisterObject( boost::string_ref fullPath ) = 0;

  virtual StatusCode unregisterObject( boost::string_ref parentPath, boost::string_ref objPath ) = 0;

  virtual StatusCode unregisterObject( boost::string_ref parentPath, int item ) = 0;

  virtual StatusCode unregisterObject( DataObject* pObject ) = 0;

  virtual StatusCode unregisterObject( DataObject* pParent, boost::string_ref objPath ) = 0;

  virtual StatusCode unregisterObject( DataObject* pParent, int item ) = 0;

  virtual StatusCode retrieveObject( IRegistry* pDirectory, boost::string_ref path, DataObject*& pObject ) = 0;

  virtual StatusCode retrieveObject( boost::string_ref fullPath, DataObject*& pObject ) = 0;

  virtual StatusCode retrieveObject( boost::string_ref parentPath, boost::string_ref objectPath,
                                     DataObject*& pObject ) = 0;

  virtual StatusCode retrieveObject( boost::string_ref parentPath, int item, DataObject*& pObject ) = 0;

  virtual StatusCode retrieveObject( DataObject* parentObj, boost::string_ref objectPath, DataObject*& pObject ) = 0;

  virtual StatusCode retrieveObject( DataObject* parentObj, int item, DataObject*& pObject ) = 0;

  virtual StatusCode findObject( IRegistry* pDirectory, boost::string_ref path, DataObject*& pObject ) = 0;

  virtual StatusCode findObject( boost::string_ref fullPath, DataObject*& pObject ) = 0;

  virtual StatusCode findObject( boost::string_ref parentPath, boost::string_ref objectPath, DataObject*& pObject ) = 0;

  virtual StatusCode findObject( boost::string_ref parentPath, int item, DataObject*& pObject ) = 0;

  virtual StatusCode findObject( DataObject* pNode, boost::string_ref objectPath, DataObject*& pObject ) = 0;

  virtual StatusCode findObject( DataObject* parentObj, int item, DataObject*& pObject ) = 0;

  virtual StatusCode updateObject( IRegistry* pDirectory ) = 0;

  virtual StatusCode updateObject( boost::string_ref fullPath ) = 0;

  virtual StatusCode updateObject( DataObject* toUpdate ) = 0;

  virtual StatusCode updateObject( boost::string_ref parentPath, boost::string_ref updatePath ) = 0;

  virtual StatusCode updateObject( DataObject* pParent, boost::string_ref updatePath ) = 0;

  virtual StatusCode addPreLoadItem( const DataStoreItem& item ) = 0;

  virtual StatusCode addPreLoadItem( std::string itemPath ) = 0;

  virtual StatusCode removePreLoadItem( const DataStoreItem& item ) = 0;

  virtual StatusCode removePreLoadItem( std::string itemPath ) = 0;

  virtual StatusCode resetPreLoad() = 0;

  virtual StatusCode preLoad() = 0;

  virtual StatusCode linkObject( IRegistry* from, boost::string_ref objPath, DataObject* toObj ) = 0;

  virtual StatusCode linkObject( boost::string_ref fromPath, boost::string_ref objPath, DataObject* toObj ) = 0;

  virtual StatusCode linkObject( DataObject* fromObj, boost::string_ref objPath, DataObject* toObj ) = 0;

  virtual StatusCode linkObject( boost::string_ref fullPath, DataObject* toObj ) = 0;

  virtual StatusCode unlinkObject( IRegistry* from, boost::string_ref objPath ) = 0;

  virtual StatusCode unlinkObject( boost::string_ref fromPath, boost::string_ref objPath ) = 0;

  virtual StatusCode unlinkObject( DataObject* fromObj, boost::string_ref objPath ) = 0;

  virtual StatusCode unlinkObject( boost::string_ref fullPath ) = 0;

  enum class Status : StatusCode::code_t {
    IDataProviderSvc_NO_ERROR = 1,
    DOUBL_OBJ_PATH,
    INVALID_OBJ_PATH,
    INVALID_ROOT,
    INVALID_OBJECT,
    INVALID_PARENT,
    OBJ_NOT_LOADED,
    NO_DATA_LOADER,
    INVALID_OBJ_ADDR,
    DIR_NOT_EMPTY,
    NO_MORE_LEVELS,
    NO_ACCESS,
    LAST
  };
};

STATUSCODE_ENUM_DECL( IDataProviderSvc::Status )

#endif // GAUDIKERNEL_IDATAPROVIDERSVC_H