midgard_metadata

midgard_metadata

Synopsis


#include <midgard/midgard.h>

typedef             midgard_metadata;
                    MidgardMetadata;
                    MidgardMetadataClass;
                    MidgardMetadataPrivate;
MidgardMetadata *   midgard_metadata_new                (MgdObject *object);

Object Hierarchy

  GObject
   +----midgard_dbobject
         +----midgard_metadata

Properties

  "approved"                 midgard_timestamp*    : Read
  "approver"                 gchar*                : Read
  "authors"                  gchar*                : Read / Write
  "created"                  midgard_timestamp*    : Read
  "creator"                  gchar*                : Read
  "deleted"                  gboolean              : Read
  "exported"                 midgard_timestamp*    : Read
  "hidden"                   gboolean              : Read / Write
  "imported"                 midgard_timestamp*    : Read
  "isapproved"               gboolean              : Read
  "islocked"                 gboolean              : Read
  "locked"                   midgard_timestamp*    : Read
  "locker"                   gchar*                : Read
  "navnoentry"               gboolean              : Read / Write
  "owner"                    gchar*                : Read / Write
  "published"                midgard_timestamp*    : Read / Write
  "revised"                  midgard_timestamp*    : Read
  "revision"                 guint                 : Read
  "revisor"                  gchar*                : Read
  "scheduleend"              midgard_timestamp*    : Read / Write
  "schedulestart"            midgard_timestamp*    : Read / Write
  "score"                    gint                  : Read / Write
  "size"                     guint                 : Read

Signals

  "set-created"                                    : Run Last / No Recursion / No Hooks
  "set-updated"                                    : Run Last / No Recursion / No Hooks

Description

Details

midgard_metadata

typedef struct _MidgardMetadata midgard_metadata;


MidgardMetadata

typedef struct {
	GObject parent;	
	MidgardDBObjectPrivate *dbpriv;
	MidgardMetadataPrivate *priv;
} MidgardMetadata;


MidgardMetadataClass

typedef struct {
	GObjectClass parent;
	MidgardDBObjectPrivate *dbpriv;
	
	guint signal_set_created;
	guint signal_set_updated;
	
	void (*set_created) (MgdObject *self);
	void (*set_updated) (MgdObject *self);	
} MidgardMetadataClass;


MidgardMetadataPrivate

typedef struct _MidgardMetadataPrivate MidgardMetadataPrivate;


midgard_metadata_new ()

MidgardMetadata *   midgard_metadata_new                (MgdObject *object);

Creates new midgard_metadata instance for the given MgdObject instance.

Do not use g_object_new() as metadata constructor. MgdObject pointer is internally assigned as a pointer to midgard object for which particular metadata object instance was created.

MidgardMetadata object has two "kinds" of properties. The first one is settable ( and overwritten ) only by metadata implementation. The second one is freely settable by application. In this case midgard core keep value of such property "as is".

Do not free MidgardMetadata object's memory as it is automatically freed when particular MgdObject object's instance memory is freed.

object :

MgdObject for which metadata is created

Returns :

newly allocated midgard_metadata instance

Property Details

The "approved" property

  "approved"                 midgard_timestamp*    : Read

ISO datetime when object's record has been (un)approved.


The "approver" property

  "approver"                 gchar*                : Read

Guid of the person who (un)approved object's record.

Default value: NULL


The "authors" property

  "authors"                  gchar*                : Read / Write

The person who is an author.

Default value: ""


The "created" property

  "created"                  midgard_timestamp*    : Read

ISO datetime when object's record has been created.


The "creator" property

  "creator"                  gchar*                : Read

Guid of the person who created object's record.

Default value: NULL


The "deleted" property

  "deleted"                  gboolean              : Read

Whether object is deleted or not.

Default value: FALSE


The "exported" property

  "exported"                 midgard_timestamp*    : Read

Whether object has been exported or not.


The "hidden" property

  "hidden"                   gboolean              : Read / Write

Whether object should be hidden or not.

Default value: FALSE


The "imported" property

  "imported"                 midgard_timestamp*    : Read

Whether object has been imported or not.


The "isapproved" property

  "isapproved"               gboolean              : Read

Whether object is approved or not.

Default value: FALSE


The "islocked" property

  "islocked"                 gboolean              : Read

Whether object is locked or unlocked.

Default value: FALSE


The "locked" property

  "locked"                   midgard_timestamp*    : Read

ISO datetime when object's record has been (un)locked.


The "locker" property

  "locker"                   gchar*                : Read

Guid of the person who (un)locked object's record.

Default value: NULL


The "navnoentry" property

  "navnoentry"               gboolean              : Read / Write

Whether object is part of navigation (e.g. menu).

Default value: FALSE


The "owner" property

  "owner"                    gchar*                : Read / Write

Group's guid which is an owner of the object.

Default value: ""


The "published" property

  "published"                midgard_timestamp*    : Read / Write

ISO datetime when object should be published (by default it's created time).


The "revised" property

  "revised"                  midgard_timestamp*    : Read

ISO datetime when object's record has been revised.


The "revision" property

  "revision"                 guint                 : Read

Object's record revision number.

Default value: 0


The "revisor" property

  "revisor"                  gchar*                : Read

Guid of the person who revised object's record.

Default value: NULL


The "scheduleend" property

  "scheduleend"              midgard_timestamp*    : Read / Write

ISO datetime when publication time ends.


The "schedulestart" property

  "schedulestart"            midgard_timestamp*    : Read / Write

ISO datetime when publication time starts.


The "score" property

  "score"                    gint                  : Read / Write

Object's record score.

Default value: 0


The "size" property

  "size"                     guint                 : Read

Object's size in bytes.

Default value: 0

Signal Details

The "set-created" signal

void                user_function                      (midgard_metadata *midgard_metadata,
                                                        gpointer          user_data)             : Run Last / No Recursion / No Hooks

midgard_metadata :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "set-updated" signal

void                user_function                      (midgard_metadata *midgard_metadata,
                                                        gpointer          user_data)             : Run Last / No Recursion / No Hooks

midgard_metadata :

the object which received the signal.

user_data :

user data set when the signal handler was connected.