gnc-lot.h

Go to the documentation of this file.

/********************************************************************\
 * gnc-lot.h -- AR/AP invoices; inventory lots; stock lots          *
 *                                                                  *
 * This program 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 2 of   *
 * the License, or (at your option) any later version.              *
 *                                                                  *
 * This program 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 this program; if not, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
\********************************************************************/
#ifndef GNC_LOT_H
#define GNC_LOT_H

//typedef struct _GncLotClass GNCLotClass;

#include "qof.h"
#include "gnc-engine.h"
/*#include "gnc-lot-p.h"*/
#include "gncInvoice.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct
{
    QofInstanceClass parent_class;
} GncLotClass;
#define GNCLotClass GncLotClass

/* --- type macros --- */
#define GNC_TYPE_LOT            (gnc_lot_get_type ())
#define GNC_LOT(o)              \
     (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_LOT, GNCLot))
#define GNC_LOT_CLASS(k)        \
     (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_LOT, GNCLotClass))
#define GNC_IS_LOT(o)           \
     (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_LOT))
#define GNC_IS_LOT_CLASS(k)     \
     (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_LOT))
#define GNC_LOT_GET_CLASS(o)    \
     (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_LOT, GNCLotClass))
GType gnc_lot_get_type(void);


/*@ dependent @*/
GNCLot * gnc_lot_new (QofBook *);
void gnc_lot_destroy (GNCLot *);

/*@ dependent @*/
GNCLot * gnc_lot_lookup (const GncGUID *guid, QofBook *book);
QofBook * gnc_lot_get_book (GNCLot *);

void gnc_lot_begin_edit (GNCLot *lot);
void gnc_lot_commit_edit (GNCLot *lot);

void gnc_lot_add_split (GNCLot *, Split *);

void gnc_lot_remove_split (GNCLot *, Split *);

SplitList * gnc_lot_get_split_list (const GNCLot *);
gint gnc_lot_count_splits (const GNCLot *);

/*@ dependent @*/
Account * gnc_lot_get_account (const GNCLot *);
void gnc_lot_set_account(GNCLot*, Account*);

/*@ dependent @*/
GncInvoice * gnc_lot_get_cached_invoice (const GNCLot *lot);
void gnc_lot_set_cached_invoice(GNCLot* lot, GncInvoice *invoice);

gnc_numeric gnc_lot_get_balance (GNCLot *);

void gnc_lot_get_balance_before (const GNCLot *, const Split *,
                                 gnc_numeric *, gnc_numeric *);

gboolean gnc_lot_is_closed (GNCLot *);

Split * gnc_lot_get_earliest_split (GNCLot *lot);

Split * gnc_lot_get_latest_split (GNCLot *lot);

void gnc_lot_set_closed_unknown(GNCLot*);

const char * gnc_lot_get_title (const GNCLot *);
const char * gnc_lot_get_notes (const GNCLot *);
void gnc_lot_set_title (GNCLot *, const char *);
void gnc_lot_set_notes (GNCLot *, const char *);
GNCLot * gnc_lot_make_default (Account * acc);

#define gnc_lot_get_guid(X)  qof_entity_get_guid(QOF_INSTANCE(X))

#define LOT_IS_CLOSED   "is-closed?"
#define LOT_BALANCE     "balance"
#define LOT_TITLE       "lot-title"
#define LOT_NOTES       "notes"

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* GNC_LOT_H */