midgard/midgard_sitegroup.h

/* 
 * Copyright (C) 2006 Piotr Pokora <piotr.pokora@infoglob.pl>
 *
 * 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 MIDGARD_SITEGROUP_H
#define MIDGARD_SITEGROUP_H

#include "midgard/midgard_connection.h"

/* convention macros */
#define MIDGARD_TYPE_SITEGROUP (midgard_sitegroup_get_type())
#define MIDGARD_SITEGROUP(object)  \
                (G_TYPE_CHECK_INSTANCE_CAST ((object),MIDGARD_TYPE_SITEGROUP, MidgardSitegroup))
#define MIDGARD_SITEGROUP_CLASS(klass)  \
                (G_TYPE_CHECK_CLASS_CAST ((klass), MIDGARD_TYPE_SITEGROUP, MidgardSitegroupClass))
#define MIDGARD_IS_SITEGROUP(object)   \
                (G_TYPE_CHECK_INSTANCE_TYPE ((object), MIDGARD_TYPE_SITEGROUP))
#define MIDGARD_IS_SITEGROUP_CLASS(klass) \
                (G_TYPE_CHECK_CLASS_TYPE ((klass), MIDGARD_TYPE_SITEGROUP))
#define MIDGARD_SITEGROUP_GET_CLASS(obj) \
                (G_TYPE_INSTANCE_GET_CLASS ((object), MIDGARD_TYPE_SITEGROUP, MidgardSitegroupClass))

typedef struct _MidgardSitegroup MidgardSitegroup;

typedef struct _MidgardSitegroupClass MidgardSitegroupClass;

extern MidgardSitegroup *midgard_sitegroup_new(MidgardConnection *mgd);

extern gboolean midgard_sitegroup_get(MidgardSitegroup *sitegroup, const gchar *guid);

extern GObjects **midgard_sitegroup_list(MidgardSitegroup *sitegroup);

/*
 * \ingroup sitegroup
 *
 * Creates new record for the given MidgardSitegroup object.
 * This method can be used only by SG0 Midgard Administrator.
 *
 * \param sitegroup MidgardSitegroup
 * \return TRUE when record was successully created , FALSE otherwise.
 *
 * Before this method is invoked SG0 Midgard Administrator is responsible 
 * to set values for these properties:
 * 
 * - name
 * - realm
 *  
 * Optionally public value property may be set. By default it's set to TRUE. 
 *
 * ?? Should we create admingroup in the background automagically ?? 
 * ?? Any use case to create sitegroup without admingroup ??
 */
extern gboolean midgard_sitegroup_create(MidgardSitegroup *sitegroup);


extern gboolean midgard_sitegroup_update(MidgardSitegroup *sitegroup);

extern gboolean midgard_sitegroup_delete(MidgardSitegroup *sitegroup);  

#endif /* MIDGARD_SITEGROUP_H */

---