Back to Seed Clases

Midgard

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Midgard.DBObject
Midgard.Object

Class Midgard.Object

Import line:	Midgard = imports.gi.Midgard;
GIR File:	Midgard-10.05.gir
C documentation:	MidgardObject
Class :	Object
Extends:	Midgard.DBObject
	Show / Hide Inherited methods, properties and signals

Properties
Properties		Defined By
	action : String	Midgard.Object
	dbpriv : Midgard.DBObjectPrivate read only	Midgard.DBObject
	guid : String read only	Midgard.Object
	metadata : Midgard.Metadata	Midgard.Object
	parent : Midgard.DBObject read only	Midgard.Object
	priv : Midgard.ObjectPrivate read only	Midgard.Object

Methods / Constructors
Method / Constructor		Defined By
	new Midgard.Object (Object *properties) Create a new Midgard.Object Create a new Midgard.Object Parameters: Object properties*
	new Midgard.Object.c_new (Connection *mgd, String name, Value value) : Midgard.Object Create a new Midgard.Object Create a new Midgard.Object Parameters: Midgard.Connection mgd* Required (not null) String name Required (not null) GObject.Value value Required (not null) Returns: Midgard.Object
	approve () : Boolean Approve object. Approve object. Approval functionality is not used by midgard core itself. Instead, it supports higher level's applications. It means, that there are no core methods ( like update or delete ) which do real check if object is approved. You should create own approval midgard_object_unapprove() and this one. This method updates metadata properties: revisor, revised, revision, approver and approved. Cases to return FALSE: No user logged in ( MGD_ERR_ACCESS_DENIED ) No active person ( MGD_ERR_INTERNAL ) Object is already approved Returns: Boolean	Midgard.Object
	build_path () : String Returns: String	Midgard.Object
	create () : Boolean Creates new database record(s) for object. Creates new database record(s) for object. Internally such properties are set (overwritten): guid (if not set by root) id (if set as primary property) Metadata overwritten properties: creator created revisor revised revision published ( set only, if not defined by user ) Cases to return FALSE: Property registered with MGD_TYPE_GUID doesn't hold valid guid ( MGD_ERR_INVALID_PROPERTY_VALUE ) Object's class is registered with tree facilities and there is already object with the same name in midgard tree. ( MGD_ERR_DUPLICATE ) Object has guid property set already. ( MGD_ERR_DUPLICATE ) Quota is activated and its limit is reached ( MGD_ERR_QUOTA ) Unspecified internal error ( MGD_ERR_INTERNAL ) Returns: Boolean	Midgard.Object
	create_attachment (String *name, String title, String mimetype) : Midgard.Object Creates object's attachment using given properties. Creates object's attachment using given properties. Any property may be explicitly set to NULL. Parameters: String name* Required (not null) String title Required (not null) String mimetype Required (not null) Returns: Midgard.Object	Midgard.Object
	delete (Boolean *check_dependents) : Boolean Delete object's record(s) from database, but object's record is not fully deleted from database. Delete object's record(s) from database, but object's record is not fully deleted from database. Instead, it is marked as deleted , thus it is possible to undelete object later with midgard_schema_object_factory_object_undelete(). If check_dependents* toggle is TRUE, parameters and attachments storage will be queried, if any of such exist and depend on deleted object. If given object's class has no metadata defined, object will be purged. Use midgard_object_purge() if you need to purge object's data from database. Cases to return FALSE: Object's has no storage defined ( MGD_ERR_OBJECT_NO_STORAGE ) Object's property guid is empty ( MGD_ERR_INVALID_PROPERTY_VALUE ) There are still dependent objects in database ( MGD_ERR_HAS_DEPENDENTS ) Unspecified internal error ( MGD_ERR_INTERNAL ) Parameters: Boolean check_dependents Required (not null) Returns: Boolean	Midgard.Object
	delete_attachments (Number *n_params, Parameter parameters) : Boolean Delete object's attachments(s) which match given properties' values. Delete object's attachments(s) which match given properties' values. Properties list in parameters* is optional. All object's attachments are deleted ( if exist ) if parameters is explicitly set to NULL. Parameters: Number n_params Required (not null) GObject.Parameter parameters Required (not null) Returns: Boolean	Midgard.Object
	delete_parameters (Number *n_params, Parameter parameters) : Boolean Delete object's parameter(s) which match given properties' values. Delete object's parameter(s) which match given properties' values. Properties list in parameters* is optional. All object's parameters are deleted ( if exist ) if parameters is explicitly set to NULL. Parameters: Number n_params Required (not null) GObject.Parameter parameters Required (not null) Returns: Boolean	Midgard.Object
	find_attachments (Number *n_params, Parameter parameters) : Midgard.Object Find object's attachment(s) with matching given properties. Find object's attachment(s) with matching given properties. returned ( if exist ) if parameters* is explicitly set to NULL. Parameters: Number n_params Required (not null) GObject.Parameter parameters Required (not null) Returns: Midgard.Object or NULL on failure	Midgard.Object
	find_parameters (Number *n_params, Parameter parameters) : Midgard.Object Find object's parameter(s) with matching given properties. Find object's parameter(s) with matching given properties. returned ( if exist ) if parameters* is explicitly set to NULL. Parameters: Number n_params Required (not null) GObject.Parameter parameters Required (not null) Returns: Midgard.Object or NULL on failure	Midgard.Object
	get_by_guid (String *guid) : Boolean Fetch object's record(s) from database using 'guid' property constraint. Fetch object's record(s) from database using 'guid' property constraint. MidgardObject object instance must be created with midgard_object_new function. When midgard connection handler is not associated with object instance, application is terminated with 'assertion fails' error message being logged. Object instance created with this function should be freed using g_object_unref. Cases to return FALSE: Object's record can not be fetched from database ( MGD_ERR_NOT_EXISTS ) unspecified internal error ( MGD_ERR_INTERNAL ) Parameters: String guid* Required (not null) Returns: Boolean	Midgard.Object
	get_by_id (Number id) : Boolean Fetch object's record(s) from database using 'id' property. Fetch object's record(s) from database using 'id' property. This is common practice to use 'id' property with integer type when table's id column stores unique, primary key value which identifies object and its record(s). However primary property with integer type is freely defined by user. MidgardObject object instance must be created with midgard_object_new function. When midgard connection handler is not associated with object instance, application is terminated with 'assertion fails' error message being logged. Object instance created with this function should be freed using g_object_unref. Cases to return FALSE: There's no 'id' primary property registered for object's class ( MGD_ERR_INTERNAL ) Object's record can not be fetched from database ( MGD_ERR_NOT_EXISTS ) unspecified internal error ( MGD_ERR_INTERNAL ) Parameters: Number id Required (not null) Returns: Boolean	Midgard.Object
	get_by_path (String *path) : Boolean Parameters: String path* Required (not null) Returns: Boolean	Midgard.Object
	get_connection () : Midgard.Connection Returned MidgardConnection is owned by core, and should not be freed. Returned MidgardConnection is owned by core, and should not be freed. Returns: Midgard.Connection	Midgard.Object
	get_parameter (String *domain, String name) : GObject.Value Parameters: String domain* Required (not null) String name Required (not null) Returns: GObject.Value	Midgard.Object
	get_schema_property (String *property) : GObject.Value Parameters: String property* Required (not null) Returns: GObject.Value	Midgard.Object
	has_attachments () : Boolean Returns: Boolean	Midgard.Object
	has_dependents () : Boolean Checks whether object has dependent objects. Checks whether object has dependent objects. Check is done with such particular order: Objects of the same type Children objects Parameters Attachments Returns: Boolean	Midgard.Object
	has_parameters () : Boolean Returns: Boolean	Midgard.Object
	is_approved () : Boolean Check whether object is approved. Check whether object is approved. Returns: Boolean	Midgard.Object
	is_locked () : Boolean Check whether object is locked Cases to return FALSE: Metadata class not defined for given object's class ( MGD_ERR_NO_METADATA ) Check whether object is locked Cases to return FALSE: Metadata class not defined for given object's class ( MGD_ERR_NO_METADATA ) Returns: Boolean	Midgard.Object
	list_attachments () : Midgard.Object Returned objects are midgard_attachment class. Returned objects are midgard_attachment class. Attachments objects are fetched from database unconditionally. That is, only those which parent guid property matches object's guid. Returned array should be freed when no longer needed. Returns: Midgard.Object	Midgard.Object
	list_parameters (String *domain) : Midgard.Object Returned objects are midgard_parameter class. Returned objects are midgard_parameter class. Parameter objects are fetched from database unconditionally if domain i sexplicitly set to NULL. That is, only those which parent guid property matches object's guid. Returned array should be freed when no longer needed. Parameters: String domain* Required (not null) Returns: Midgard.Object	Midgard.Object
	lock () : Boolean Lock object. Lock object. This method doesn't affect any core's functionality like midgard_object_approve. You should create own locking workflow and logic with methods: midgard_object_is_locked(), midgard_object_unlock() and this one. Updates metadata properties: locker, locked, revisor, revised and revision Cases to return FALSE: No user logged in ( MGD_ERR_ACCESS_DENIED ) Metadata class not defined for given object's class ( MGD_ERR_NO_METADATA ) Object is already locked ( MGD_ERR_OBJECT_IS_LOCKED ) Returns: Boolean	Midgard.Object
	purge (Boolean *check_dependents) : Boolean Purge object's record(s) from database. Purge object's record(s) from database. If check_dependents* toggle is TRUE, parameters and attachments storage will be queried, if any of such exist and depend on deleted object. Object's record(s) are purged from database without any possibility to recover. After successfull call, only repligard table holds information about object's state. Use midgard_object_delete(), if undelete facility is needed. Cases to return FALSE: Object has no storage defined ( MGD_ERR_OBJECT_NO_STORAGE ) Object's property guid value is empty ( MGD_ERR_INVALID_PROPERTY_VALUE ) There are still dependent objects in database ( MGD_ERR_HAS_DEPENDANTS ) No record has been deleted from database ( MGD_ERR_NOT_EXISTS ) Unspecified internal error ( MGD_ERR_INTERNAL ) Parameters: Boolean check_dependents Required (not null) Returns: Boolean	Midgard.Object
	purge_attachments (Boolean *delete_blob, Number n_params, Parameter parameters) : Boolean Purge object's attachments(s) which match given properties' values. Purge object's attachments(s) which match given properties' values. Properties list in parameters* is optional. All object's attachments are purged ( if exist ) if parameters is explicitly set to NULL. to blob located on filesystem ( it should be set to TRUE by default ). However, if midgard_attachment is created for blobs sharing and file should not be deleted, delete_blob should be set to FALSE. There's no way to determine if midgard_attachment is sharing blob, so aplication itelf is responsible to create such own logic. Parameters: Boolean delete_blob Required (not null) Number n_params Required (not null) GObject.Parameter parameters Required (not null) Returns: Boolean	Midgard.Object
	purge_parameters (Number *n_params, Parameter parameters) : Boolean Purge object's parameter(s) which match given properties' values. Purge object's parameter(s) which match given properties' values. Properties list in parameters* is optional. All object's parameters are purged ( if exist ) if parameters is explicitly set to NULL. Parameters: Number n_params Required (not null) GObject.Parameter parameters Required (not null) Returns: Boolean	Midgard.Object
	set_connection (Connection *mgd) : none Parameters: Midgard.Connection mgd* Required (not null) Returns: none	Midgard.Object
	set_guid (String *guid) : Boolean Sets object's guid Cases to return FALSE: given guid already exists in database ( MGD_ERR_DUPLICATE ) given guid is invalid ( MGD_ERR_INVALID_PROPERTY_VALUE ) object has already set guid property ( MGD_ERR_INVALID_PROPERTY_VALUE ) Sets object's guid Cases to return FALSE: given guid already exists in database ( MGD_ERR_DUPLICATE ) given guid is invalid ( MGD_ERR_INVALID_PROPERTY_VALUE ) object has already set guid property ( MGD_ERR_INVALID_PROPERTY_VALUE ) Parameters: String guid* Required (not null) Returns: Boolean	Midgard.Object
	set_parameter (String *domain, String name, Value value) : Boolean Creates object's parameter object if it doesn't exists, updates otherwise. Creates object's parameter object if it doesn't exists, updates otherwise. Parameters: String domain* Required (not null) String name Required (not null) GObject.Value value Required (not null) Returns: Boolean	Midgard.Object
	set_schema_property (String *property, Value value) : none Parameters: String property* Required (not null) GObject.Value value Required (not null) Returns: none	Midgard.Object
	unapprove () : Boolean Simply unapprove object. Simply unapprove object. It doesn't affect any core functionality, like midgard_object_approve(). This method updates metadata properties: revisor, revised, revision, approver and approved Cases to return FALSE: No user logged in ( MGD_ERR_ACCESS_DENIED ) Object is not approved Returns: Boolean	Midgard.Object
	unlock () : Boolean Unlock object. Unlock object. Cases to return FALSE: No user logged in ( MGD_ERR_ACCESS_DENIED ) Object is not locked ( FIXME ) Metadata class not defined for given object's class ( MGD_ERR_NO_METADATA ) Returns: Boolean	Midgard.Object
	update () : Boolean Update object's record(s). Update object's record(s). Internally such metadata properties are set (overwritten): revisor revision ( increased by one ) revised Cases to return FALSE: Property registered with MGD_TYPE_GUID doesn't hold valid guid ( MGD_ERR_INVALID_PROPERTY_VALUE ) Object's class is registered with tree facilities and there is already such object in midgard tree ( MGD_ERR_DUPLICATE ) Quota is activated and its limit is reached ( MGD_ERR_QUOTA ) Unspecified internal error ( MGD_ERR_INTERNAL ) Returns: Boolean is successfully updated, FALSE otherwise.	Midgard.Object

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	action_approve (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_approve_hook (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_approved (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_create (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_create_hook (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_created (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_delete (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_delete_hook (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_deleted (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_export (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_export_hook (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_exported (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_import (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_import_hook (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_imported (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_loaded (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_loaded_hook (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_lock (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_lock_hook (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_locked (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_purge (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_purge_hook (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_purged (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_unapprove (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_unapprove_hook (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_unapproved (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_unlock (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_unlock_hook (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_unlocked (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_update (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_update_hook (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object
	action_updated (Object *self) : none Parameters: Midgard.Object self* Returns: {none}	Midgard.Object

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Midgard Method	Midgard.quota_create (Object *object*) : Boolean
Midgard Method	Midgard.quota_get_object_size (Object *object*) : Number
Midgard Method	Midgard.quota_remove (Object *object, Number size*) : none
Midgard Method	Midgard.quota_size_is_reached (Object *object, Number size*) : Boolean
Midgard Method	Midgard.quota_update (Object *object, Number init_size*) : Boolean
Midgard.Blob Method	new Midgard.Blob.c_new (Object *attachment, String encoding*) : Midgard.Blob Create a new Midgard.Blob
Midgard.Replicator Method	Midgard.Replicator.serialize_blob (Object *object*) : String Serialize midgard_blob binary data.
Midgard.Replicator Method	Midgard.Replicator.export_blob (Object *object*) : String Alias for midgard_replicator_serialize_blob().
Midgard.Replicator Method	Midgard.Replicator.export_media (Object *object*) : String
Midgard.SchemaObjectFactory Method	Midgard.SchemaObjectFactory.get_object_by_guid (Connection *mgd, String guid*) : Midgard.Object Creates new instance of the class defined in Midgard Schema.
Midgard.SchemaObjectFactory Method	Midgard.SchemaObjectFactory.get_object_by_path (Connection *mgd, String classname, String path*) : Midgard.Object Get object by path.
Midgard.SchemaObjectTree Method	Midgard.SchemaObjectTree.is_in_tree (Object *object, Object parent_object*) : Boolean
Midgard.SchemaObjectTree Method	Midgard.SchemaObjectTree.get_parent_name (Object *object*) : String
Midgard.SchemaObjectTree Method	Midgard.SchemaObjectTree.get_parent_object (Object *object) : Midgard.Object Get tree parent object, of the given object*.
Midgard.SchemaObjectTree Method	Midgard.SchemaObjectTree.list_objects (Object *object, Object out_values) : Midgard.Object List tree children objects, of given object* type.
Midgard.SchemaObjectTree Method	Midgard.SchemaObjectTree.list_children_objects (Object *object, String classname, Object out_values) : Midgard.Object List all classname* objects, if exist and are tree children of given object.
Midgard.User Method	get_person () : Midgard.Object Returned object should not be unref.
Midgard.User Method	set_person (Object *person) : Boolean Associates given MidgardObject* person with self MidgardUser.

Un-official Seed Documentation

Midgard

Classes

Interfaces

Structs

Unions

Enums

Class Midgard.Object