CalendarStorage.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 CALENDARSTORAGE_H_
#define CALENDARSTORAGE_H_

#include "Storage.hpp"
#include <PIMItem/Calendar/PIMCalendarItem.hpp>

namespace OpenAB_Storage {

//TODO: update documentation
class CalendarStorage : public Storage
{
  public:
    CalendarStorage(OpenAB::PIMItemType type);

    virtual ~CalendarStorage();

    enum Storage::eAddItem addItem(const OpenAB::SmartPtr<OpenAB::PIMItem>& item,
                                   OpenAB::PIMItem::ID & newId,
                                   OpenAB::PIMItem::Revision & revision);
    enum Storage::eAddItem addItems(const std::vector<OpenAB::SmartPtr<OpenAB::PIMItem> > & items,
                                    OpenAB::PIMItem::IDs & newIds,
                                    OpenAB::PIMItem::Revisions & revisions);
    enum Storage::eModifyItem modifyItem(const OpenAB::SmartPtr<OpenAB::PIMItem>& item,
                                         const OpenAB::PIMItem::ID & id,
                                         OpenAB::PIMItem::Revision & revision);
    enum Storage::eModifyItem modifyItems(const std::vector<OpenAB::SmartPtr<OpenAB::PIMItem> > & items,
                                          const OpenAB::PIMItem::IDs & ids,
                                          OpenAB::PIMItem::Revisions & revisions);
    enum Storage::eRemoveItem removeItem(const OpenAB::PIMItem::ID & id);
    enum Storage::eRemoveItem removeItems(const OpenAB::PIMItem::IDs & ids);
    enum Storage::eGetItem getItem(const OpenAB::PIMItem::ID & id, OpenAB::SmartPtr<OpenAB::PIMItem> & item);
    enum Storage::eGetItem getItems(const OpenAB::PIMItem::IDs & id, std::vector<OpenAB::SmartPtr<OpenAB::PIMItem> > & item);

    virtual enum Storage::eAddItem addObject( const std::string& iCal,
                                              OpenAB::PIMItem::ID& newId,
                                              OpenAB::PIMItem::Revision& revision) = 0;

    virtual enum Storage::eAddItem addObjects( const std::vector<std::string> &iCals,
                                               OpenAB::PIMItem::IDs& newIds,
                                               OpenAB::PIMItem::Revisions& revisions) = 0;

    virtual enum Storage::eModifyItem modifyObject ( const std::string& iCal,
                                                     const OpenAB::PIMItem::ID& id,
                                                     OpenAB::PIMItem::Revision& revision) = 0;

    virtual enum Storage::eModifyItem modifyObjects( const std::vector<std::string> &iCals,
                                                     const OpenAB::PIMItem::IDs& ids,
                                                     OpenAB::PIMItem::Revisions& revisions) = 0;
    virtual enum Storage::eRemoveItem removeObject( const OpenAB::PIMItem::ID& id) = 0;

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

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

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

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

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

  private:
    CalendarStorage(CalendarStorage const &other);

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

} // namespace OpenAB_Storage

#endif // CALENDARSTORAGE_H_