qof_book_mergeRule Struct Reference
[Merging QofBook structures]

#include <qof_book_merge.h>

---

Detailed Description

One rule per entity, built into a single GList for the entire merge.

All rules are stored in the GList qof_book_mergeData::mergeList.

If the GUID matches it's the always same semantic object, regardless of whether other data fields are changed.
The boolean value mergeAbsolute defaults to FALSE

NOTE 1: if mergeAbsolute == TRUE, qof_book_mergeResult will still be set to MERGE_UPDATE if parameters within this entity have been modified.

NOTE 2: qof_book_merge_param_as_string returns string representations of the parameter data that is causing a collision. These values must NOT be used to set the target parameter - the function is provided for display purposes only, to make it simple to explain the collision to the user using MERGE_REPORT and the dialog.

The GHashTable targetTable in qof_book_mergeRule will probably replace the GSList of the same name in mergeData.

Definition at line 157 of file qof_book_merge.h.

Data Fields
gboolean	mergeAbsolute
double	difference
gboolean	updated
QofIdType	mergeType
const char *	mergeLabel
GSList *	mergeParam
GSList *	linkedEntList
qof_book_mergeResult	mergeResult
QofEntity *	importEnt
QofEntity *	targetEnt

---

Field Documentation

double qof_book_mergeRule::difference

used to find best match in a book where no GUID matches Definition at line 161 of file qof_book_merge.h.

QofEntity* qof_book_mergeRule::importEnt

pointer to the current entity in the import book. Definition at line 177 of file qof_book_merge.h.

GSList* qof_book_mergeRule::linkedEntList

list of complex data types included in this object. linkedEntList contains an QofEntity reference to any parameter that is not one of the core QOF_TYPE data types. This entity must be already registered with QOF and the results of the comparison for the linked entity will modulate the mergeResult of this object. e.g. if an invoice is the same value but for a different customer, the invoice will be set to MERGE_REPORT and the customer as MERGE_NEW. Definition at line 168 of file qof_book_merge.h.

gboolean qof_book_mergeRule::mergeAbsolute

Only set if the GUID of the import matches the target Definition at line 160 of file qof_book_merge.h.

const char* qof_book_mergeRule::mergeLabel

Descriptive label for the object type, useful for the user intervention dialog. Definition at line 165 of file qof_book_merge.h.

GSList* qof_book_mergeRule::mergeParam

list of usable parameters for the object type Definition at line 167 of file qof_book_merge.h.

qof_book_mergeResult qof_book_mergeRule::mergeResult

result of comparison with main QofBook Definition at line 176 of file qof_book_merge.h.

QofIdType qof_book_mergeRule::mergeType

type of comparison required for check for collision Definition at line 164 of file qof_book_merge.h.

QofEntity* qof_book_mergeRule::targetEnt

pointer to the corresponding entity in the target book, if any. Definition at line 178 of file qof_book_merge.h.

gboolean qof_book_mergeRule::updated

prevent the mergeResult from being overwritten. Definition at line 162 of file qof_book_merge.h.

---

The documentation for this struct was generated from the following file:

• qof_book_merge.h

---