kitlistdao.hpp

Go to the documentation of this file.

/*

    This file is part of Kitlist, a program to maintain a simple list
    of items and assign items to one or more categories.

    Copyright (C) 2008,2009 Frank Dean

    Kitlist is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Kitlist is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Kitlist.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef KIT_LIST_DAO_H
#define KIT_LIST_DAO_H 1

#include "category.hpp"
#include "item.hpp"
#include "kitmodel.hpp"
#include <string>


enum item_choice {
    ALL_ITEMS,
    CHECKED_ITEMS,
    UNCHECKED_ITEMS };


class KitListDao {
protected :
    int m_verbose_flag; 
public :
    KitListDao(int verbose = 0) : m_verbose_flag(verbose) {}

    virtual ~KitListDao() {}

    virtual KitModel* get_model() = 0;

    virtual void save_model(KitModel* model) = 0;

    void set_verbose(int verbose_flag) {
        m_verbose_flag = verbose_flag;
    }

    int is_verbose() { return m_verbose_flag; };

    virtual Category* get_category(long cat_id, item_choice choice = ALL_ITEMS) = 0;

    virtual ItemContainer* get_all_items(item_choice choice = ALL_ITEMS) = 0;

    virtual long add_item(const std::string name) = 0;

    virtual long add_item(const std::string name, long cat_id) = 0;

    virtual void append_items_to_category(long to_cat_id, long from_cat_id = -1, item_choice choice = ALL_ITEMS) = 0;

    virtual void associate_item_with_category(long id, long cat_id) = 0;

    virtual CategoryContainer get_categories() = 0;

    virtual long new_category(const std::string name) = 0;

    virtual void delete_item(long id) = 0;

    virtual void update_item_checked_state(ItemContainer& items) = 0;

    virtual void remove_item_from_category(long id, long cat_id) = 0;

    virtual long get_next_item_id() = 0;

    virtual long get_next_category_id() = 0;

    virtual void delete_category(long id) = 0;

    virtual void set_item_flag(long id) = 0;

    virtual void unset_item_flag(long id) = 0;

    virtual void set_category_flag(long id) = 0;

    virtual void unset_category_flag(long id) = 0;

    virtual void set_all_flags() = 0;

    virtual void unset_all_flags() = 0;

    virtual bool require_filename() { return false; }
};
#endif //KIT_LIST_DAO_H