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 <string>

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

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

  enum { SEPARATOR = '/' };

  virtual StatusCode registerObject(const std::string& fullPath,
                                    DataObject* pObject) = 0;

  virtual StatusCode registerObject(const std::string& parentPath,
                                    const std::string& objectPath,
                                    DataObject* pObject) = 0;

  virtual StatusCode registerObject(const std::string& parentPath,
                                    int item,
                                    DataObject* pObject) = 0;

  virtual StatusCode registerObject(DataObject* parentObj,
                                    const std::string& objectPath,
                                    DataObject* pObject) = 0;

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

  virtual StatusCode unregisterObject(const std::string& fullPath) = 0;

  virtual StatusCode unregisterObject(const std::string& parentPath,
                                      const std::string& objPath) = 0;

  virtual StatusCode unregisterObject(const std::string& parentPath,
                                      int item) = 0;

  virtual StatusCode unregisterObject(DataObject* pObject) = 0;

  virtual StatusCode unregisterObject(DataObject* pParent,
                                      const std::string& objPath) = 0;

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

  virtual StatusCode retrieveObject(IRegistry* pDirectory,
                                    const std::string& path,
                                    DataObject*& pObject) = 0;

  virtual StatusCode retrieveObject(const std::string& fullPath,
                                    DataObject*& pObject) = 0;

  virtual StatusCode retrieveObject(const std::string& parentPath,
                                    const std::string& objectPath,
                                    DataObject*& pObject) = 0;

  virtual StatusCode retrieveObject(const std::string& parentPath,
                                    int item, DataObject*& pObject) = 0;

  virtual StatusCode retrieveObject(DataObject* parentObj,
                                    const std::string& objectPath,
                                    DataObject*& pObject) = 0;

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

  virtual StatusCode findObject(IRegistry* pDirectory,
                                const std::string& path,
                                DataObject*& pObject) = 0;

  virtual StatusCode findObject(const std::string& fullPath,
                                DataObject*& pObject) = 0;

  virtual StatusCode findObject(const std::string& parentPath,
                                const std::string& objectPath,
                                DataObject*& pObject) = 0;

  virtual StatusCode findObject(const std::string& parentPath,
                                int item,
                                DataObject*& pObject) = 0;

  virtual StatusCode findObject(DataObject* pNode,
                                const std::string& objectPath,
                                DataObject*& pObject) = 0;

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

  virtual StatusCode updateObject(IRegistry* pDirectory) = 0;

  virtual StatusCode updateObject(const std::string& fullPath) = 0;

  virtual StatusCode updateObject(DataObject* toUpdate) = 0;

  virtual StatusCode updateObject(const std::string& parentPath,
                                  const std::string& updatePath) = 0;

  virtual StatusCode updateObject(DataObject* pParent,
                                  const std::string& updatePath) = 0;

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

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

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

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

  virtual StatusCode resetPreLoad() = 0;

  virtual StatusCode preLoad() = 0;

  virtual StatusCode linkObject(IRegistry* from,
                                const std::string& objPath,
                                DataObject* toObj) = 0;

  virtual StatusCode linkObject(const std::string& fromPath,
                                const std::string& objPath,
                                DataObject* toObj) = 0;

  virtual StatusCode linkObject(DataObject* fromObj,
                                const std::string& objPath,
                                DataObject* toObj) = 0;

  virtual StatusCode linkObject(const std::string& fullPath,
                                DataObject* toObj) = 0;

  virtual StatusCode unlinkObject(IRegistry* from,
                                  const std::string& objPath) = 0;

  virtual StatusCode unlinkObject(const std::string& fromPath,
                                  const std::string& objPath) = 0;

  virtual StatusCode unlinkObject(DataObject* fromObj,
                                  const std::string& objPath) = 0;

  virtual StatusCode unlinkObject(const std::string& fullPath) = 0;

  enum Status  {
    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
  };

  virtual ~IDataProviderSvc() {}
};

#endif // GAUDIKERNEL_IDATAPROVIDERSVC_H