Object_Private
[Object: Dynamic Object Class Framework]

---

Detailed Description

Private interfaces, not meant to be used by applications.

Private interfaces, not meant to be used by applications.

Private interfaces, not meant to be used by applications.

Files
file	qofbackend-p.h
	private api for data storage backend
file	qofobject-p.h
	the Core Object Registration/Lookup Private Interface
Data Structures
struct	QofBackendProvider_s
struct	QofBackend_s
struct	_QofBook
Book_Private
#define	qof_book_set_guid(book, guid)   qof_entity_set_guid(QOF_ENTITY(book), guid)
void	qof_book_set_backend (QofBook *book, QofBackend *be)
void	qof_book_set_schedxactions (QofBook *book, GList *newList)
gboolean	qof_book_register (void)
Backend_Private
Pseudo-object defining how the engine can interact with different back-ends (which may be SQL databases, or network interfaces to remote GnuCash servers. File-io is just one type of backend). The callbacks will be called at the appropriate times during a book session to allow the backend to store the data as needed.
void	qof_backend_register_provider (QofBackendProvider *)
void	qof_backend_set_error (QofBackend *be, QofBackendError err)
QofBackendError	qof_backend_get_error (QofBackend *be)
void	qof_backend_set_message (QofBackend *be, const char *format,...)
char *	qof_backend_get_message (QofBackend *be)
void	qof_backend_init (QofBackend *be)
gchar	qof_book_get_open_marker (QofBook *book)
gint32	qof_book_get_version (QofBook *book)
guint32	qof_book_get_idata (QofBook *book)
void	qof_book_set_version (QofBook *book, gint32 version)
void	qof_book_set_idata (QofBook *book, guint32 idata)
Class_Private
void	qof_class_init (void)
void	qof_class_shutdown (void)
QofSortFunc	qof_class_get_default_sort (QofIdTypeConst obj_name)
Entity_Private
void	qof_entity_set_guid (QofEntity *ent, const GUID *guid)
void	qof_collection_insert_entity (QofCollection *, QofEntity *)
void	qof_collection_mark_clean (QofCollection *)
void	qof_collection_mark_dirty (QofCollection *)
Objects_Private
void	qof_object_book_begin (QofBook *book)
void	qof_object_book_end (QofBook *book)
gboolean	qof_object_is_dirty (QofBook *book)
void	qof_object_mark_clean (QofBook *book)

---

Define Documentation

#define qof_book_set_guid (  book, guid   )     qof_entity_set_guid(QOF_ENTITY(book), guid)

Deprecated: use qof_entity_set_guid instead but only in backends (when reading the GUID from the data source). Definition at line 110 of file qofbook-p.h.

---

Function Documentation

QofBackendError qof_backend_get_error (  QofBackend *  be  )

The qof_backend_get_error() routine pops an error code off the error stack. Definition at line 58 of file qofbackend.c. { QofBackendError err; if (!be) return ERR_BACKEND_NO_BACKEND; /* use 'stack-pop' semantics */ err = be->last_err; be->last_err = ERR_BACKEND_NO_ERR; return err; }

char* qof_backend_get_message (  QofBackend *  be  )

The qof_backend_get_message() pops the error message string from the Backend. This string should be freed with g_free(). Definition at line 94 of file qofbackend.c. { char * msg; if (!be) return g_strdup("ERR_BACKEND_NO_BACKEND"); if (!be->error_msg) return NULL; /* * Just return the contents of the error_msg and then set it to * NULL. This is necessary, because the Backends don't seem to * have a destroy_backend function to take care if freeing stuff * up. The calling function should free the copy. * Also, this is consistent with the qof_backend_get_error() popping. */ msg = be->error_msg; be->error_msg = NULL; return msg; }

void qof_backend_register_provider (  QofBackendProvider *   )

Let the sytem know about a new provider of backends. This function is typically called by the provider library at library load time. This function allows the backend library to tell the QOF infrastructure that it can handle URL's of a certain type. Note that a single backend library may register more than one provider, if it is capable of handling more than one URL access method. Definition at line 65 of file qofsession.c. { provider_list = g_slist_prepend (provider_list, prov); }

void qof_backend_set_error (  QofBackend *  be, QofBackendError  err )

The qof_backend_set_error() routine pushes an error code onto the error stack. (FIXME: the stack is 1 deep in current implementation). Definition at line 48 of file qofbackend.c. { if (!be) return; /* use stack-push semantics. Only the earliest error counts */ if (ERR_BACKEND_NO_ERR != be->last_err) return; be->last_err = err; }

void qof_backend_set_message (  QofBackend *  be, const char *  format,   ... )

The qof_backend_set_message() assigns a string to the backend error message. Definition at line 70 of file qofbackend.c. { va_list args; char * buffer; if (!be) return; /* If there's already something here, free it */ if (be->error_msg) g_free(be->error_msg); if (!format) { be->error_msg = NULL; return; } va_start(args, format); buffer = (char *)g_strdup_vprintf(format, args); va_end(args); be->error_msg = buffer; }

guint32 qof_book_get_idata (  QofBook *  book  )

get the book tag number used for kvp management in sql backends. Definition at line 302 of file qofbook.c. { if(!book) { return 0; } return book->idata; }

gchar qof_book_get_open_marker (  QofBook *  book  )

Allow backends to see if the book is open Returns: 'y' if book is open, otherwise 'n'. Definition at line 290 of file qofbook.c. { if(!book) { return 'n'; } return book->book_open; }

gint32 qof_book_get_version (  QofBook *  book  )

get the book version used for tracking multiuser updates in backends. Returns: -1 if no book exists, 0 if the book is new, otherwise the book version number. Definition at line 296 of file qofbook.c. { if(!book) { return -1; } return book->version; }

void qof_book_set_schedxactions (  QofBook *  book, GList *  newList )

Deprecated:

void qof_collection_insert_entity (  QofCollection *  , QofEntity *  )

Take entity, remove it from whatever collection its currently in, and place it in a new collection. To be used only for moving entity from one book to another. Definition at line 191 of file qofid.c. { if (!col || !ent) return; if (guid_equal(&ent->guid, guid_null())) return; g_return_if_fail (col->e_type == ent->e_type); qof_collection_remove_entity (ent); g_hash_table_insert (col->hash_of_entities, &ent->guid, ent); ent->collection = col; }

void qof_collection_mark_clean (  QofCollection *   )

reset value of dirty flag Definition at line 334 of file qofid.c. { if (!col) return; col->is_dirty = FALSE; }

void qof_entity_set_guid (  QofEntity *  ent, const GUID *  guid )

Set the ID of the entity, over-riding the previous ID. Very dangerous, use only for file i/o work. Definition at line 91 of file qofid.c. { QofCollection *col; if (guid_equal (guid, &ent->guid)) return; col = ent->collection; qof_collection_remove_entity (ent); ent->guid = *guid; qof_collection_insert_entity (col, ent); }

void qof_object_book_begin (  QofBook *  book  )

To be called from within the book Definition at line 60 of file qofobject.c. { GList *l; if (!book) return; ENTER (" "); for (l = object_modules; l; l = l->next) { QofObject *obj = l->data; if (obj->book_begin) obj->book_begin (book); } /* Remember this book for later */ book_list = g_list_prepend (book_list, book); LEAVE (" "); }

---