GDataGDOrganization

GDataGDOrganization — GData organization element

Stability Level

Unstable, unless otherwise indicated

Synopsis


#include <gdata/gd/gdata-gd-organization.h>

                    GDataGDOrganization;
                    GDataGDOrganizationClass;
GDataGDOrganization * gdata_gd_organization_new         (const gchar *name,
                                                         const gchar *title,
                                                         const gchar *relation_type,
                                                         const gchar *label,
                                                         gboolean is_primary);
gint                gdata_gd_organization_compare       (const GDataGDOrganization *a,
                                                         const GDataGDOrganization *b);
const gchar *       gdata_gd_organization_get_name      (GDataGDOrganization *self);
void                gdata_gd_organization_set_name      (GDataGDOrganization *self,
                                                         const gchar *name);
const gchar *       gdata_gd_organization_get_title     (GDataGDOrganization *self);
void                gdata_gd_organization_set_title     (GDataGDOrganization *self,
                                                         const gchar *title);
const gchar *       gdata_gd_organization_get_relation_type
                                                        (GDataGDOrganization *self);
void                gdata_gd_organization_set_relation_type
                                                        (GDataGDOrganization *self,
                                                         const gchar *relation_type);
const gchar *       gdata_gd_organization_get_label     (GDataGDOrganization *self);
void                gdata_gd_organization_set_label     (GDataGDOrganization *self,
                                                         const gchar *label);
gboolean            gdata_gd_organization_is_primary    (GDataGDOrganization *self);
void                gdata_gd_organization_set_is_primary
                                                        (GDataGDOrganization *self,
                                                         gboolean is_primary);
const gchar *       gdata_gd_organization_get_department
                                                        (GDataGDOrganization *self);
void                gdata_gd_organization_set_department
                                                        (GDataGDOrganization *self,
                                                         const gchar *department);
const gchar *       gdata_gd_organization_get_job_description
                                                        (GDataGDOrganization *self);
void                gdata_gd_organization_set_job_description
                                                        (GDataGDOrganization *self,
                                                         const gchar *job_description);
const gchar *       gdata_gd_organization_get_symbol    (GDataGDOrganization *self);
void                gdata_gd_organization_set_symbol    (GDataGDOrganization *self,
                                                         const gchar *symbol);

Object Hierarchy

  GObject
   +----GDataParsable
         +----GDataGDOrganization

Properties

  "department"               gchar*                : Read / Write
  "is-primary"               gboolean              : Read / Write
  "job-description"          gchar*                : Read / Write
  "label"                    gchar*                : Read / Write
  "name"                     gchar*                : Read / Write
  "relation-type"            gchar*                : Read / Write
  "symbol"                   gchar*                : Read / Write
  "title"                    gchar*                : Read / Write

Description

GDataGDOrganization represents an "organization" element from the GData specification.

Details

GDataGDOrganization

typedef struct _GDataGDOrganization GDataGDOrganization;

All the fields in the GDataGDOrganization structure are private and should never be accessed directly.


GDataGDOrganizationClass

typedef struct {
} GDataGDOrganizationClass;

All the fields in the GDataGDOrganizationClass structure are private and should never be accessed directly.

Since 0.4.0


gdata_gd_organization_new ()

GDataGDOrganization * gdata_gd_organization_new         (const gchar *name,
                                                         const gchar *title,
                                                         const gchar *relation_type,
                                                         const gchar *label,
                                                         gboolean is_primary);

Creates a new GDataGDOrganization. More information is available in the GData specification.

name :

the name of the organization, or NULL

title :

the owner's title within the organization, or NULL

relation_type :

the relationship between the organization and its owner, or NULL

label :

a human-readable label for the organization, or NULL

is_primary :

TRUE if this organization is its owner's primary organization, FALSE otherwise

Returns :

a new GDataGDOrganization, or NULL; unref with g_object_unref()

Since 0.2.0


gdata_gd_organization_compare ()

gint                gdata_gd_organization_compare       (const GDataGDOrganization *a,
                                                         const GDataGDOrganization *b);

Compares the two organizations in a strcmp() fashion. NULL values are handled gracefully, with 0 returned if both a and b are NULL, -1 if a is NULL and 1 if b is NULL.

The comparison of non-NULL values is done on the basis of the name property of the GDataGDOrganizations.

a :

a GDataGDOrganization, or NULL

b :

another GDataGDOrganization, or NULL

Returns :

0 if a equals b, -1 or 1 as appropriate otherwise

Since 0.4.0


gdata_gd_organization_get_name ()

const gchar *       gdata_gd_organization_get_name      (GDataGDOrganization *self);

Gets the "name" property.

self :

a GDataGDOrganization

Returns :

the organization's name, or NULL

Since 0.4.0


gdata_gd_organization_set_name ()

void                gdata_gd_organization_set_name      (GDataGDOrganization *self,
                                                         const gchar *name);

Sets the "name" property to name.

Set name to NULL to unset the property in the organization.

self :

a GDataGDOrganization

name :

the new name for the organization

Since 0.4.0


gdata_gd_organization_get_title ()

const gchar *       gdata_gd_organization_get_title     (GDataGDOrganization *self);

Gets the "title" property.

self :

a GDataGDOrganization

Returns :

the organization's title, or NULL

Since 0.4.0


gdata_gd_organization_set_title ()

void                gdata_gd_organization_set_title     (GDataGDOrganization *self,
                                                         const gchar *title);

Sets the "title" property to title.

Set title to NULL to unset the property in the organization.

self :

a GDataGDOrganization

title :

the new title for the organization, or NULL

Since 0.4.0


gdata_gd_organization_get_relation_type ()

const gchar *       gdata_gd_organization_get_relation_type
                                                        (GDataGDOrganization *self);

Gets the "relation-type" property.

self :

a GDataGDOrganization

Returns :

the organization's relation type, or NULL

Since 0.4.0


gdata_gd_organization_set_relation_type ()

void                gdata_gd_organization_set_relation_type
                                                        (GDataGDOrganization *self,
                                                         const gchar *relation_type);

Sets the "relation-type" property to relation_type.

Set relation_type to NULL to unset the property in the organization.

self :

a GDataGDOrganization

relation_type :

the new relation type for the organization, or NULL

Since 0.4.0


gdata_gd_organization_get_label ()

const gchar *       gdata_gd_organization_get_label     (GDataGDOrganization *self);

Gets the "label" property.

self :

a GDataGDOrganization

Returns :

the organization's label, or NULL

Since 0.4.0


gdata_gd_organization_set_label ()

void                gdata_gd_organization_set_label     (GDataGDOrganization *self,
                                                         const gchar *label);

Sets the "label" property to label.

Set label to NULL to unset the property in the organization.

self :

a GDataGDOrganization

label :

the new label for the organization, or NULL

Since 0.4.0


gdata_gd_organization_is_primary ()

gboolean            gdata_gd_organization_is_primary    (GDataGDOrganization *self);

Gets the "is-primary" property.

self :

a GDataGDOrganization

Returns :

TRUE if this is the primary organization, FALSE otherwise

Since 0.4.0


gdata_gd_organization_set_is_primary ()

void                gdata_gd_organization_set_is_primary
                                                        (GDataGDOrganization *self,
                                                         gboolean is_primary);

Sets the "is-primary" property to is_primary.

self :

a GDataGDOrganization

is_primary :

TRUE if this is the primary organization, FALSE otherwise

Since 0.4.0


gdata_gd_organization_get_department ()

const gchar *       gdata_gd_organization_get_department
                                                        (GDataGDOrganization *self);

Gets the "department" property.

self :

a GDataGDOrganization

Returns :

the department in which the person works in this organization, or NULL

Since 0.5.0


gdata_gd_organization_set_department ()

void                gdata_gd_organization_set_department
                                                        (GDataGDOrganization *self,
                                                         const gchar *department);

Sets the "department" property to department.

Set department to NULL to unset the property in the organization.

self :

a GDataGDOrganization

department :

the new department for the person working in the organization

Since 0.5.0


gdata_gd_organization_get_job_description ()

const gchar *       gdata_gd_organization_get_job_description
                                                        (GDataGDOrganization *self);

Gets the "job-description" property.

self :

a GDataGDOrganization

Returns :

the job description of the person in the organization, or NULL

Since 0.5.0


gdata_gd_organization_set_job_description ()

void                gdata_gd_organization_set_job_description
                                                        (GDataGDOrganization *self,
                                                         const gchar *job_description);

Sets the "job-description" property to job_description.

Set job_description to NULL to unset the property in the organization.

self :

a GDataGDOrganization

job_description :

the new job description for the person in the organization

Since 0.5.0


gdata_gd_organization_get_symbol ()

const gchar *       gdata_gd_organization_get_symbol    (GDataGDOrganization *self);

Gets the "symbol" property.

self :

a GDataGDOrganization

Returns :

the organization's stock symbol, or NULL

Since 0.5.0


gdata_gd_organization_set_symbol ()

void                gdata_gd_organization_set_symbol    (GDataGDOrganization *self,
                                                         const gchar *symbol);

Sets the "symbol" property to symbol.

Set symbol to NULL to unset the property in the organization.

self :

a GDataGDOrganization

symbol :

the new stock symbol for the organization

Since 0.5.0

Property Details

The "department" property

  "department"               gchar*                : Read / Write

Specifies a department within the organization.

For more information, see the GData specification.

Default value: NULL

Since 0.5.0


The "is-primary" property

  "is-primary"               gboolean              : Read / Write

Indicates which organization out of a group is primary.

For more information, see the GData specification.

Default value: FALSE

Since 0.4.0


The "job-description" property

  "job-description"          gchar*                : Read / Write

Description of a job within the organization.

For more information, see the GData specification.

Default value: NULL

Since 0.5.0


The "label" property

  "label"                    gchar*                : Read / Write

A simple string value used to name this organization. It allows UIs to display a label such as "Work", "Volunteer", "Professional Society", etc.

For more information, see the GData specification.

Default value: NULL

Since 0.4.0


The "name" property

  "name"                     gchar*                : Read / Write

The name of the organization.

For more information, see the GData specification.

Default value: NULL

Since 0.4.0


The "relation-type" property

  "relation-type"            gchar*                : Read / Write

A programmatic value that identifies the type of organization.

For more information, see the GData specification.

Default value: NULL

Since 0.4.0


The "symbol" property

  "symbol"                   gchar*                : Read / Write

Stock symbol of the organization.

For more information, see the GData specification.

Default value: NULL

Since 0.5.0


The "title" property

  "title"                    gchar*                : Read / Write

The title of a person within the organization.

For more information, see the GData specification.

Default value: NULL

Since 0.4.0