Customer

Files
file	gncCustomer.h
	Core Customer Interface.

Data Structures
struct	GncCustomer

Macros
#define	GNC_ID_CUSTOMER   "gncCustomer"
#define	GNC_TYPE_CUSTOMER   (gnc_customer_get_type ())
#define	GNC_CUSTOMER(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_CUSTOMER, GncCustomer))
#define	GNC_CUSTOMER_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_CUSTOMER, GncCustomerClass))
#define	GNC_IS_CUSTOMER(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_CUSTOMER))
#define	GNC_IS_CUSTOMER_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_CUSTOMER))
#define	GNC_CUSTOMER_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_CUSTOMER, GncCustomerClass))
#define	CUSTOMER_ID   "id"
#define	CUSTOMER_NAME   "name"
#define	CUSTOMER_ADDR   "addr"
#define	CUSTOMER_SHIPADDR   "shipaddr"
#define	CUSTOMER_NOTES   "notes"
#define	CUSTOMER_DISCOUNT   "amount of discount"
#define	CUSTOMER_CREDIT   "amount of credit"
#define	CUSTOMER_TT_OVER   "tax table override"
#define	CUSTOMER_TAX_INC   "customer_tax_included"
#define	CUSTOMER_TERMS   "customer_terms"
#define	CUSTOMER_ACTIVE   "customer_is_active"
#define	CUSTOMER_SLOTS   "customer_values"
#define	gncCustomerGetGUID(x)   qof_instance_get_guid(QOF_INSTANCE(x))
#define	gncCustomerRetGUID(x)   (x ? *(qof_instance_get_guid(QOF_INSTANCE(x))) : *(guid_null()))
#define	gncCustomerGetBook(x)   qof_instance_get_book(QOF_INSTANCE(x))
#define	gncCustomerLookupDirect(g, b)   gncCustomerLookup((b), &(g))

Typedefs
typedef struct _gncCustomer	GncCustomer
typedef struct _gncCustomerClass	GncCustomerClass

Functions
GType	gnc_customer_get_type (void)
int	gncCustomerCompare (const GncCustomer *a, const GncCustomer *b)
gboolean	gncCustomerEqual (const GncCustomer *a, const GncCustomer *b)
GList *	gncCustomerGetJoblist (const GncCustomer *customer, gboolean show_all)
gboolean	gncCustomerIsDirty (GncCustomer *customer)

Create/Destroy Functions
GncCustomer *	gncCustomerCreate (QofBook *book)
void	gncCustomerDestroy (GncCustomer *customer)
void	gncCustomerBeginEdit (GncCustomer *customer)
void	gncCustomerCommitEdit (GncCustomer *customer)

Set Functions
void	gncCustomerSetID (GncCustomer *customer, const char *id)
void	gncCustomerSetName (GncCustomer *customer, const char *name)
void	gncCustomerSetNotes (GncCustomer *customer, const char *notes)
void	gncCustomerSetTerms (GncCustomer *customer, GncBillTerm *term)
void	gncCustomerSetTaxIncluded (GncCustomer *customer, GncTaxIncluded taxincl)
void	gncCustomerSetActive (GncCustomer *customer, gboolean active)
void	gncCustomerSetDiscount (GncCustomer *customer, gnc_numeric discount)
void	gncCustomerSetCredit (GncCustomer *customer, gnc_numeric credit)
void	gncCustomerSetCurrency (GncCustomer *customer, gnc_commodity *currency)
void	gncCustomerSetTaxTableOverride (GncCustomer *customer, gboolean override)
void	gncCustomerSetTaxTable (GncCustomer *customer, GncTaxTable *table)
void	gncCustomerAddJob (GncCustomer *customer, GncJob *job)
void	gncCustomerRemoveJob (GncCustomer *customer, GncJob *job)

Get Functions
const char *	gncCustomerGetID (const GncCustomer *customer)
const char *	gncCustomerGetName (const GncCustomer *customer)
GncAddress *	gncCustomerGetAddr (const GncCustomer *customer)
GncAddress *	gncCustomerGetShipAddr (const GncCustomer *customer)
const char *	gncCustomerGetNotes (const GncCustomer *customer)
GncBillTerm *	gncCustomerGetTerms (const GncCustomer *customer)
GncTaxIncluded	gncCustomerGetTaxIncluded (const GncCustomer *customer)
gboolean	gncCustomerGetActive (const GncCustomer *customer)
gnc_numeric	gncCustomerGetDiscount (const GncCustomer *customer)
gnc_numeric	gncCustomerGetCredit (const GncCustomer *customer)
gnc_commodity *	gncCustomerGetCurrency (const GncCustomer *customer)
gboolean	gncCustomerGetTaxTableOverride (const GncCustomer *customer)
GncTaxTable *	gncCustomerGetTaxTable (const GncCustomer *customer)

Detailed Description

Macro Definition Documentation

#define gncCustomerGetGUID

(

x

)

qof_instance_get_guid(QOF_INSTANCE(x))

Deprecated:

functions, should be removed

Definition at line 156 of file gncCustomer.h.

Function Documentation

gboolean gncCustomerEqual	(	const GncCustomer *	a,
		const GncCustomer *	b
	)

Test support function, used in gets-dbi-business-stuff.c

Definition at line 741 of file gncCustomer.c.

{
    if (a == NULL && b == NULL) return TRUE;
    if (a == NULL || b == NULL) return FALSE;

    g_return_val_if_fail(GNC_IS_CUSTOMER(a), FALSE);
    g_return_val_if_fail(GNC_IS_CUSTOMER(b), FALSE);

    if (g_strcmp0(a->id, b->id) != 0)
    {
        PWARN("IDs differ: %s vs %s", a->id, b->id);
        return FALSE;
    }

    if (g_strcmp0(a->name, b->name) != 0)
    {
        PWARN("Names differ: %s vs %s", a->name, b->name);
        return FALSE;
    }

    if (g_strcmp0(a->notes, b->notes) != 0)
    {
        PWARN("Notes differ: %s vs %s", a->notes, b->notes);
        return FALSE;
    }

    if (!gncBillTermEqual(a->terms, b->terms))
    {
        PWARN("Bill terms differ");
        return FALSE;
    }

    if (!gnc_commodity_equal(a->currency, b->currency))
    {
        PWARN("currencies differ");
        return FALSE;
    }

    if (!gncTaxTableEqual(a->taxtable, b->taxtable))
    {
        PWARN("tax tables differ");
        return FALSE;
    }

    if (a->taxtable_override != b->taxtable_override)
    {
        PWARN("Tax table override flags differ");
        return FALSE;
    }

    if (a->taxincluded != b->taxincluded)
    {
        PWARN("Tax included flags differ");
        return FALSE;
    }

    if (a->active != b->active)
    {
        PWARN("Active flags differ");
        return FALSE;
    }

    if (!gncAddressEqual(a->addr, b->addr))
    {
        PWARN("addresses differ");
        return FALSE;
    }
    if (!gncAddressEqual(a->shipaddr, b->shipaddr))
    {
        PWARN("addresses differ");
        return FALSE;
    }

    if (!gnc_numeric_equal(a->credit, b->credit))
    {
        PWARN("Credit amounts differ");
        return FALSE;
    }

    if (!gnc_numeric_equal(a->discount, b->discount))
    {
        PWARN("Discount amounts differ");
        return FALSE;
    }

    /* FIXME: Need to check jobs list
    GList *         jobs;
    */

    return TRUE;
}