Source.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 SOURCE_HPP_
#define SOURCE_HPP_

#include <map>
#include <string>
#include <vector>
#include <plugin/Plugin.hpp>
#include <plugin/GenericParameters.hpp>
#include <PIMItem/PIMItem.hpp>

namespace OpenAB_Source {

typedef OpenAB_Plugin::GenericParameters Parameters;


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

    virtual ~Source(){};

    enum eInit{
      eInitOk,   
      eInitFail  
    };

    virtual enum eInit init() = 0;

    enum eSuspendRet{
      eSuspendRetOk,           
      eSuspendRetFail,         
      eSuspendRetNotSupported  
    };

    virtual enum eSuspendRet suspend() = 0;

    enum eResumeRet{
      eResumeRetOk,           
      eResumeRetFail,         
      eResumeRetNotSupported  
    };

    virtual enum eResumeRet resume() = 0;

    enum eCancelRet{
      eCancelRetOk,           
      eCancelRetFail,         
      eCancelRetNotSupported  
    };

    virtual enum eCancelRet cancel() = 0;

    enum eGetItemRet {
      eGetItemRetOk,   
      eGetItemRetEnd,  
      eGetItemRetError 
    };

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

    virtual int getTotalCount() const = 0;

    OpenAB::PIMItemType getItemType() const
    {
      return itemType;
    }

  private:
    Source(Source const &other);

    Source& operator=(Source const &other);

    OpenAB::PIMItemType itemType;
};

} // namespace OpenAB_Source

DECLARE_PLUGIN_INTERFACE(OpenAB_Source, Source, Parameters);

#endif // SOURCE_HPP_