midgard/types.h

/* 
Copyright (C) 2004,2005,2006 Piotr Pokora <piotr.pokora@infoglob.pl>
Copyright (C) 2004 Alexander Bokovoy <ab@samba.org>

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef TYPES_H
#define TYPES_H

#include "midgard/midgard_legacy.h"
#include <glib-object.h>
#include <midgard/query_builder.h>

#define MIDGARD_TYPE_OBJECT midgard_object_get_type()
#define MIDGARD_OBJECT(object)  (G_TYPE_CHECK_INSTANCE_CAST ((object), MIDGARD_TYPE_OBJECT, MgdObject))
#define MIDGARD_OBJECT_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), MIDGARD_TYPE_OBJECT, MidgardObjectClass))
#define MIDGARD_IS_OBJECT(object)   (G_TYPE_CHECK_INSTANCE_TYPE ((object), MIDGARD_TYPE_OBJECT))
#define MIDGARD_IS_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), MIDGARD_TYPE_OBJECT))
#define MIDGARD_OBJECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), MIDGARD_TYPE_OBJECT, MidgardObjectClass))
#define MIDGARD_OBJECT_GET_CLASS_BY_NAME(name) ((MidgardObjectClass*) g_type_class_peek(g_type_from_name(name)))

typedef struct _MgdObject MgdObject;
typedef struct _MidgardObjectClass MidgardObjectClass;

typedef struct _MidgardTypePrivate MidgardTypePrivate;

typedef struct MidgardMetadata MidgardMetadata;
typedef struct MidgardMetadataClass MidgardMetadataClass;

/* Get object by id and by type , only for backwards compatibility */

#define _MIDGARD_OBJECT_GET_BY_TYPE(klassname) \
    if ((object = midgard_object_new(mgd, klassname, NULL)) != NULL ) { \
        g_object_set((GObject*) object, "id" , (guint)id, NULL ); \
        if ((midgard_object_get_by_id(object)) == 0);  \
        return object; \
        return NULL; \
    } else { \
        return NULL; \
    } \

struct _MgdObject {
        GObject parent;
        
        /* private */
        MidgardTypePrivate *private;
        MgdSchemaTypeAttr *data;

        midgard *mgd;
        GType type;
        const gchar *cname;
        gpointer *klass;
        MidgardMetadata *metadata;      
};

struct _MidgardObjectClass {
        GObjectClass parent;
        
        /* private */
        MgdSchemaTypeAttr *data;        
};

extern void midgard_get_midgard(MgdObject *mobj, midgard *mgd);

extern GType midgard_object_get_type(void);

extern enum
{
        MGD_OBJECT_ACTION_NONE = 0,
        MGD_OBJECT_ACTION_DELETE,
        MGD_OBJECT_ACTION_PURGE,
        MGD_OBJECT_ACTION_CREATE,
        MGD_OBJECT_ACTION_UPDATE
}MidgardObjectAction;

extern MgdObject *midgard_object_new(midgard *mgd, const gchar *name, GValue *value);

extern MgdObject *midgard_object_new_by_id(midgard *mgd, const gchar *name, gchar *id);

extern gboolean midgard_object_get_by_id(MgdObject *object);

extern gboolean midgard_object_update(MgdObject *object);

extern gboolean midgard_object_create(MgdObject *object);

extern GObject **midgard_object_find(MgdObject *object, guint *n_objects);

extern gchar * midgard_object_build_path(MgdObject *mobj);

extern gboolean midgard_object_is_in_parent_tree(MgdObject *object, guint rootid, guint id);

extern gboolean midgard_object_is_in_tree(MgdObject *object, guint rootid, guint id);

extern gchar * midgard_object_get_tree(MgdObject *object, GSList *tnodes);

extern MgdObject *midgard_object_get_by_old_guid(midgard *mgd, gchar *guid);

extern gboolean midgard_object_get_by_guid(MgdObject *object);

/*
 * \ingroup MgdObject
 *
 * Delete object's record(s) from database.
 *
 * \param object MgdObject
 *
 * \return TRUE if object's record(s) is successfully deleted from database.
 * FALSE otherwise.
 *
 * Caller is responsible to set 'guid' property before calling this function.
 * Object's record is not fully deleted from database. Instead, it is marked 
 * as deleted , thus it is possible to undelete object later with static 
 * method midgard_object_undelete.
 *
 * FALSE is returned in such cases:
 *
 * - Midgard Schema is not set for this object ( MGD_ERR_INTERNAL )
 * - Object's has no storage defined ( MGD_ERR_OBJECT_NO_STORAGE )
 * - Object's property guid is empty ( MGD_ERR_INVALID_PROPERTY_VALUE )
 * - SQL query failed ( MGD_ERR_INTERNAL )
 *  
 */ 
extern gboolean midgard_object_delete(MgdObject *object);

extern gboolean midgard_object_purge(MgdObject *object);

extern MgdObject *midgard_object_get_parent(MgdObject *object);

extern gint midgard_object_get(MgdObject *object);

extern GObject **midgard_object_list(MgdObject *object, guint *n_objects);

extern GObject **midgard_object_list_children(MgdObject *object, const gchar *childname, 
                guint *n_objects);
extern GObject **midgard_object_get_languages(
        MgdObject *self, guint *n_objects);


extern MgdObject *midgard_get_object_by_guid(
        MidgardConnection *mgd, const gchar *guid);

extern MgdObject *midgard_object_get_by_path(midgard *mgd, const gchar *classname , const gchar *path);

extern const gchar *midgard_object_parent(MgdObject *object);

extern gboolean midgard_object_undelete(MidgardConnection *mgd, 
                        const gchar *guid);

extern gchar *midgard_object_export(MgdObject *self);


extern gboolean midgard_import_object(
                        MidgardConnection *mgd, gchar *xml);
        
#endif /* TYPES_H */

---