gncBusiness.h File Reference

#include <glib.h>
#include "qof.h"

Go to the source code of this file.

Defines
#define	GNC_BILLTERM_MODULE_NAME   GNC_ID_BILLTERM
#define	GNC_CUSTOMER_MODULE_NAME   GNC_ID_CUSTOMER
#define	GNC_EMPLOYEE_MODULE_NAME   GNC_ID_EMPLOYEE
#define	GNC_ENTRY_MODULE_NAME   GNC_ID_ENTRY
#define	GNC_INVOICE_MODULE_NAME   GNC_ID_INVOICE
#define	GNC_JOB_MODULE_NAME   GNC_ID_JOB
#define	GNC_ORDER_MODULE_NAME   GNC_ID_ORDER
#define	GNC_OWNER_MODULE_NAME   GNC_ID_OWNER
#define	GNC_TAXTABLE_MODULE_NAME   GNC_ID_TAXTABLE
#define	GNC_VENDOR_MODULE_NAME   GNC_ID_VENDOR
#define	DI(x)   x
Typedefs
typedef GList	OwnerList
Functions
GList *	gncBusinessGetList (QofBook *book, QofIdTypeConst type_name, gboolean all_including_inactive)
OwnerList *	gncBusinessGetOwnerList (QofBook *book, QofIdTypeConst type_name, gboolean all_including_inactive)

---

Detailed Description

-- Business Helper Functions

Author:

Copyright (C) 2002 Derek Atkins

Derek Atkins <warlord@MIT.EDU>

Definition in file gncBusiness.h.

---

Typedef Documentation

typedef GList OwnerList

For SWIG: A GList containing GncOwner.

Definition at line 71 of file gncBusiness.h.

---

Function Documentation

GList* gncBusinessGetList	(	QofBook *	book,
		QofIdTypeConst	type_name,
		gboolean	all_including_inactive
	)

Returns a GList of all objects of the given type_name in the given book.

OwnerList* gncBusinessGetOwnerList	(	QofBook *	book,
		QofIdTypeConst	type_name,
		gboolean	all_including_inactive
	)

Returns a GList of all objects of the given type_name in the given book, but each object is wrapped in a GncOwner object.

The wrapping was done by qofOwnerSetEntity(), hence the owner will contain data only for {CUSTOMER, JOB, VERNDOR, EMPLOYEE}, otherwise the owner will be of type GNC_OWNER_NONE and not contain the original data.