Storage.hpp

Go to the documentation of this file.

/*
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
#ifndef PIM_STORAGE_HPP_
#define PIM_STORAGE_HPP_

#include <map>
#include <string>
#include <vector>
#include <plugin/Plugin.hpp>
#include <helpers/SmartPtr.hpp>
#include <plugin/GenericParameters.hpp>
#include <plugin/source/Source.hpp>
#include "StorageItem.hpp"


namespace OpenAB_Storage {

typedef OpenAB_Plugin::GenericParameters Parameters;

class Storage : public OpenAB_Source::Source
{
  public:
    Storage(OpenAB::PIMItemType t)
      : OpenAB_Source::Source(t)
      {};

    virtual ~Storage(){};

    enum eAddItem{
      eAddItemOk,   
      eAddItemFail  
    };

    virtual enum eAddItem addItem(const OpenAB::SmartPtr<OpenAB::PIMItem>& item,
                                  OpenAB::PIMItem::ID & newId,
                                  OpenAB::PIMItem::Revision & revision) = 0;

    virtual enum eAddItem addItems(const std::vector<OpenAB::SmartPtr<OpenAB::PIMItem> > & items,
                                   OpenAB::PIMItem::IDs & newIds,
                                   OpenAB::PIMItem::Revisions & revisions) = 0;


    enum eModifyItem{
          eModifyItemOk,   
          eModifyItemFail  
    };

    virtual enum eModifyItem modifyItem(const OpenAB::SmartPtr<OpenAB::PIMItem>& item,
                                        const OpenAB::PIMItem::ID & id,
                                        OpenAB::PIMItem::Revision & revision) = 0;

    virtual enum eModifyItem modifyItems(const std::vector<OpenAB::SmartPtr<OpenAB::PIMItem> > & items,
                                         const OpenAB::PIMItem::IDs & ids,
                                         OpenAB::PIMItem::Revisions &revisions) = 0;

    enum eRemoveItem{
          eRemoveItemOk,   
          eRemoveItemFail  
    };

    virtual enum eRemoveItem removeItem(const OpenAB::PIMItem::ID & id) = 0;

    virtual enum eRemoveItem removeItems(const OpenAB::PIMItem::IDs & ids) = 0;

    enum eGetItem{
      eGetItemOk,   
      eGetItemFail  
    };

    virtual enum eGetItemRet getItem(OpenAB::SmartPtr<OpenAB::PIMItem> &item) = 0;

    virtual enum eGetItem getItem(const OpenAB::PIMItem::ID & id, OpenAB::SmartPtr<OpenAB::PIMItem>& item) = 0;

    virtual enum eGetItem getItems(const OpenAB::PIMItem::IDs & ids, std::vector<OpenAB::SmartPtr<OpenAB::PIMItem> > & items) = 0;

    enum eGetSyncToken {
      eGetSyncTokenOk,   
      eGetSyncTokenFail  
    };

    virtual OpenAB_Storage::Storage::eGetSyncToken getLatestSyncToken(std::string& token) = 0;

    enum eGetRevisions {
      eGetRevisionsOk,   
      eGetRevisionsFail  
    };

    virtual OpenAB_Storage::Storage::eGetRevisions getRevisions(std::map<std::string, std::string>& revisions) = 0;

    virtual OpenAB_Storage::Storage::eGetRevisions getChangedRevisions(const std::string& token,
                                                                    std::map<std::string, std::string>& revisions,
                                                                    std::vector<OpenAB::PIMItem::ID>& removed) = 0;


    virtual StorageItemIterator* newStorageItemIterator() = 0;


  private:
    Storage(Storage const &other);

    Storage& operator=(Storage const &other);
};

} // namespace OpenAB_Storage

DECLARE_PLUGIN_INTERFACE(OpenAB_Storage, Storage, Parameters);

#endif // PIM_STORAGE_HPP_