gdata.calendar_resource.data
index
/usr/local/svn/gdata-python-client/src/gdata/calendar_resource/data.py

Data model classes for parsing and generating XML for the Calendar
Resource API.

 
Modules
       
atom
gdata

 
Classes
       
atom.core.XmlElement(__builtin__.object)
AppsProperty
gdata.data.GDEntry(atom.data.Entry, gdata.data.LinkFinder)
CalendarResourceEntry
gdata.data.GDFeed(atom.data.Feed, gdata.data.LinkFinder)
CalendarResourceFeed

 
class AppsProperty(atom.core.XmlElement)
    Represents an <apps:property> element in a Calendar Resource feed.
 
 
Method resolution order:
AppsProperty
atom.core.XmlElement
__builtin__.object

Data and other attributes defined here:
name = 'name'
value = 'value'

Methods inherited from atom.core.XmlElement:
FindChildren = get_elements(self, tag=None, namespace=None, version=1)
Find all sub elements which match the tag and namespace.
 
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching elements.
 
Returns:
  A list of the matching XmlElements.
FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
Find all sub elements which match the tag and namespace.
 
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching elements.
 
Returns:
  A list of the matching XmlElements.
GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
Find all attributes which match the tag and namespace.
 
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching attributes.
 
Returns:
  A list of XmlAttribute objects for the matching attributes.
GetElements = get_elements(self, tag=None, namespace=None, version=1)
Find all sub elements which match the tag and namespace.
 
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching elements.
 
Returns:
  A list of the matching XmlElements.
ToString = to_string(self, version=1, encoding=None)
Converts this object to XML.
__init__(self, text=None, *args, **kwargs)
__str__(self)
get_attributes(self, tag=None, namespace=None, version=1)
Find all attributes which match the tag and namespace.
 
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching attributes.
 
Returns:
  A list of XmlAttribute objects for the matching attributes.
get_elements(self, tag=None, namespace=None, version=1)
Find all sub elements which match the tag and namespace.
 
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching elements.
 
Returns:
  A list of the matching XmlElements.
to_string(self, version=1, encoding=None)
Converts this object to XML.

Data descriptors inherited from atom.core.XmlElement:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
attributes
children
extension_attributes
extension_elements
namespace
tag

Data and other attributes inherited from atom.core.XmlElement:
text = None

 
class CalendarResourceEntry(gdata.data.GDEntry)
    Represents a Calendar Resource entry in object form.
 
 
Method resolution order:
CalendarResourceEntry
gdata.data.GDEntry
atom.data.Entry
atom.data.FeedEntryParent
atom.core.XmlElement
gdata.data.LinkFinder
atom.data.LinkFinder
__builtin__.object

Methods defined here:
GetResourceCommonName(self)
Get the common name of this Calendar Resource object.
 
Returns:
  The common name of this Calendar Resource object as a string or None.
GetResourceDescription(self)
Get the description of this Calendar Resource object.
 
Returns:
  The description of this Calendar Resource object as a string or None.
GetResourceId(self)
Get the resource ID of this Calendar Resource object.
 
Returns:
  The resource ID of this Calendar Resource object as a string or None.
GetResourceType(self)
Get the type of this Calendar Resource object.
 
Returns:
  The type of this Calendar Resource object as a string or None.
SetResourceCommonName(self, value)
Set the common name of this Calendar Resource object.
 
Args:
  value: string The new common name value to give this object.
SetResourceDescription(self, value)
Set the description of this Calendar Resource object.
 
Args:
  value: string The new description value to give this object.
SetResourceId(self, value)
Set the resource ID of this Calendar Resource object.
 
Args:
  value: string The new resource ID value to give this object.
SetResourceType(self, value)
Set the type value of this Calendar Resource object.
 
Args:
  value: string The new type value to give this object.
__init__(self, resource_id=None, resource_common_name=None, resource_description=None, resource_type=None, *args, **kwargs)
Constructs a new CalendarResourceEntry object with the given arguments.
 
Args:
  resource_id: string (optional) The resource ID to give this new object.
  resource_common_name: string (optional) The common name to give this new
                        object.
  resource_description: string (optional) The description to give this new
                        object.
  resource_type: string (optional) The type to give this new object.
  args: The other parameters to pass to gdata.entry.GDEntry constructor. 
  kwargs: The other parameters to pass to gdata.entry.GDEntry constructor.

Data descriptors defined here:
resource_common_name
Get the common name of this Calendar Resource object.
 
Returns:
  The common name of this Calendar Resource object as a string or None.
resource_description
Get the description of this Calendar Resource object.
 
Returns:
  The description of this Calendar Resource object as a string or None.
resource_id
Get the resource ID of this Calendar Resource object.
 
Returns:
  The resource ID of this Calendar Resource object as a string or None.
resource_type
Get the type of this Calendar Resource object.
 
Returns:
  The type of this Calendar Resource object as a string or None.

Data and other attributes defined here:
property = [<class 'gdata.calendar_resource.data.AppsProperty'>]

Methods inherited from gdata.data.GDEntry:
FindMediaLink = find_media_link(self)
Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
GetId = get_id(self)
IsMedia = is_media(self)
find_media_link(self)
Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
get_id(self)
is_media(self)

Data and other attributes inherited from gdata.data.GDEntry:
etag = '{http://schemas.google.com/g/2005}etag'

Data and other attributes inherited from atom.data.Entry:
content = <class 'atom.data.Content'>
The atom:content element.
control = <class 'atom.data.Control'>
The app:control element indicating restrictions on publication.
 
The APP control element may contain a draft element indicating whether or
not this entry should be publicly available.
published = <class 'atom.data.Published'>
The atom:published element.
source = <class 'atom.data.Source'>
The atom:source element.
summary = <class 'atom.data.Summary'>
The atom:summary element.

Data and other attributes inherited from atom.data.FeedEntryParent:
author = [<class 'atom.data.Author'>]
category = [<class 'atom.data.Category'>]
contributor = [<class 'atom.data.Contributor'>]
id = <class 'atom.data.Id'>
The atom:id element.
link = [<class 'atom.data.Link'>]
rights = <class 'atom.data.Rights'>
The atom:rights element.
title = <class 'atom.data.Title'>
The atom:title element.
updated = <class 'atom.data.Updated'>
The atom:updated element.

Methods inherited from atom.core.XmlElement:
FindChildren = get_elements(self, tag=None, namespace=None, version=1)
Find all sub elements which match the tag and namespace.
 
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching elements.
 
Returns:
  A list of the matching XmlElements.
FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
Find all sub elements which match the tag and namespace.
 
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching elements.
 
Returns:
  A list of the matching XmlElements.
GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
Find all attributes which match the tag and namespace.
 
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching attributes.
 
Returns:
  A list of XmlAttribute objects for the matching attributes.
GetElements = get_elements(self, tag=None, namespace=None, version=1)
Find all sub elements which match the tag and namespace.
 
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching elements.
 
Returns:
  A list of the matching XmlElements.
ToString = to_string(self, version=1, encoding=None)
Converts this object to XML.
__str__(self)
get_attributes(self, tag=None, namespace=None, version=1)
Find all attributes which match the tag and namespace.
 
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching attributes.
 
Returns:
  A list of XmlAttribute objects for the matching attributes.
get_elements(self, tag=None, namespace=None, version=1)
Find all sub elements which match the tag and namespace.
 
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching elements.
 
Returns:
  A list of the matching XmlElements.
to_string(self, version=1, encoding=None)
Converts this object to XML.

Data descriptors inherited from atom.core.XmlElement:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
attributes
children
extension_attributes
extension_elements
namespace
tag

Data and other attributes inherited from atom.core.XmlElement:
text = None

Methods inherited from gdata.data.LinkFinder:
FindAclLink = find_acl_link(self)
FindFeedLink = find_feed_link(self)
FindHtmlLink = find_html_link(self)
Finds the first link with rel of alternate and type of text/html.
FindPostLink = find_post_link(self)
Get the URL to which new entries should be POSTed.
 
The POST target URL is used to insert new entries.
 
Returns:
  A str for the URL in the link with a rel matching the POST type.
FindPreviousLink = find_previous_link(self)
GetAclLink = get_acl_link(self)
Searches for a link or feed_link (if present) with the rel for ACL.
GetFeedLink = get_feed_link(self)
GetHtmlLink = get_html_link(self)
GetPostLink = get_post_link(self)
GetPreviousLink = get_previous_link(self)
find_acl_link(self)
find_feed_link(self)
find_html_link(self)
Finds the first link with rel of alternate and type of text/html.
find_post_link(self)
Get the URL to which new entries should be POSTed.
 
The POST target URL is used to insert new entries.
 
Returns:
  A str for the URL in the link with a rel matching the POST type.
find_previous_link(self)
get_acl_link(self)
Searches for a link or feed_link (if present) with the rel for ACL.
get_feed_link(self)
get_html_link(self)
get_post_link(self)
get_previous_link(self)

Methods inherited from atom.data.LinkFinder:
FindAlternateLink = find_alternate_link(self)
FindEditLink = find_edit_link(self)
FindEditMediaLink = find_edit_media_link(self)
FindLicenseLink = find_license_link(self)
FindNextLink = find_next_link(self)
FindSelfLink = find_self_link(self)
Find the first link with rel set to 'self'
 
Returns:
  A str containing the link's href or None if none of the links had rel
  equal to 'self'
FindUrl = find_url(self, rel)
Returns the URL in a link with the desired rel value.
GetAlternateLink = get_alternate_link(self)
GetEditLink = get_edit_link(self)
GetEditMediaLink = get_edit_media_link(self)
GetLicenseLink = get_license_link(self)
GetLink = get_link(self, rel)
Returns a link object which has the desired rel value.
 
If you are interested in the URL instead of the link object,
consider using find_url instead.
GetNextLink = get_next_link(self)
GetSelfLink = get_self_link(self)
find_alternate_link(self)
find_edit_link(self)
find_edit_media_link(self)
find_license_link(self)
find_next_link(self)
find_self_link(self)
Find the first link with rel set to 'self'
 
Returns:
  A str containing the link's href or None if none of the links had rel
  equal to 'self'
find_url(self, rel)
Returns the URL in a link with the desired rel value.
get_alternate_link(self)
get_edit_link(self)
get_edit_media_link(self)
get_license_link(self)
get_link(self, rel)
Returns a link object which has the desired rel value.
 
If you are interested in the URL instead of the link object,
consider using find_url instead.
get_next_link(self)
get_self_link(self)

 
class CalendarResourceFeed(gdata.data.GDFeed)
    Represents a feed of CalendarResourceEntry objects.
 
 
Method resolution order:
CalendarResourceFeed
gdata.data.GDFeed
atom.data.Feed
atom.data.Source
atom.data.FeedEntryParent
atom.core.XmlElement
gdata.data.LinkFinder
atom.data.LinkFinder
__builtin__.object

Data and other attributes defined here:
entry = [<class 'gdata.calendar_resource.data.CalendarResourceEntry'>]

Methods inherited from gdata.data.GDFeed:
GetId = get_id(self)
get_generator(self)
get_id(self)

Data and other attributes inherited from gdata.data.GDFeed:
etag = '{http://schemas.google.com/g/2005}etag'
items_per_page = <class 'gdata.data.ItemsPerPage'>
The opensearch:itemsPerPage element in GData feed.
start_index = <class 'gdata.data.StartIndex'>
The opensearch:startIndex element in GData feed.
total_results = <class 'gdata.data.TotalResults'>
opensearch:TotalResults for a GData feed.

Data and other attributes inherited from atom.data.Source:
generator = <class 'atom.data.Generator'>
The atom:generator element.
icon = <class 'atom.data.Icon'>
The atom:icon element.
logo = <class 'atom.data.Logo'>
The atom:logo element.
subtitle = <class 'atom.data.Subtitle'>
The atom:subtitle element.

Methods inherited from atom.data.FeedEntryParent:
__init__(self, atom_id=None, text=None, *args, **kwargs)

Data and other attributes inherited from atom.data.FeedEntryParent:
author = [<class 'atom.data.Author'>]
category = [<class 'atom.data.Category'>]
contributor = [<class 'atom.data.Contributor'>]
id = <class 'atom.data.Id'>
The atom:id element.
link = [<class 'atom.data.Link'>]
rights = <class 'atom.data.Rights'>
The atom:rights element.
title = <class 'atom.data.Title'>
The atom:title element.
updated = <class 'atom.data.Updated'>
The atom:updated element.

Methods inherited from atom.core.XmlElement:
FindChildren = get_elements(self, tag=None, namespace=None, version=1)
Find all sub elements which match the tag and namespace.
 
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching elements.
 
Returns:
  A list of the matching XmlElements.
FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
Find all sub elements which match the tag and namespace.
 
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching elements.
 
Returns:
  A list of the matching XmlElements.
GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
Find all attributes which match the tag and namespace.
 
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching attributes.
 
Returns:
  A list of XmlAttribute objects for the matching attributes.
GetElements = get_elements(self, tag=None, namespace=None, version=1)
Find all sub elements which match the tag and namespace.
 
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching elements.
 
Returns:
  A list of the matching XmlElements.
ToString = to_string(self, version=1, encoding=None)
Converts this object to XML.
__str__(self)
get_attributes(self, tag=None, namespace=None, version=1)
Find all attributes which match the tag and namespace.
 
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching attributes.
 
Returns:
  A list of XmlAttribute objects for the matching attributes.
get_elements(self, tag=None, namespace=None, version=1)
Find all sub elements which match the tag and namespace.
 
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
 
Args:
  tag: str
  namespace: str
  version: int Specifies the version of the XML rules to be used when
           searching for matching elements.
 
Returns:
  A list of the matching XmlElements.
to_string(self, version=1, encoding=None)
Converts this object to XML.

Data descriptors inherited from atom.core.XmlElement:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
attributes
children
extension_attributes
extension_elements
namespace
tag

Data and other attributes inherited from atom.core.XmlElement:
text = None

Methods inherited from gdata.data.LinkFinder:
FindAclLink = find_acl_link(self)
FindFeedLink = find_feed_link(self)
FindHtmlLink = find_html_link(self)
Finds the first link with rel of alternate and type of text/html.
FindPostLink = find_post_link(self)
Get the URL to which new entries should be POSTed.
 
The POST target URL is used to insert new entries.
 
Returns:
  A str for the URL in the link with a rel matching the POST type.
FindPreviousLink = find_previous_link(self)
GetAclLink = get_acl_link(self)
Searches for a link or feed_link (if present) with the rel for ACL.
GetFeedLink = get_feed_link(self)
GetHtmlLink = get_html_link(self)
GetPostLink = get_post_link(self)
GetPreviousLink = get_previous_link(self)
find_acl_link(self)
find_feed_link(self)
find_html_link(self)
Finds the first link with rel of alternate and type of text/html.
find_post_link(self)
Get the URL to which new entries should be POSTed.
 
The POST target URL is used to insert new entries.
 
Returns:
  A str for the URL in the link with a rel matching the POST type.
find_previous_link(self)
get_acl_link(self)
Searches for a link or feed_link (if present) with the rel for ACL.
get_feed_link(self)
get_html_link(self)
get_post_link(self)
get_previous_link(self)

Methods inherited from atom.data.LinkFinder:
FindAlternateLink = find_alternate_link(self)
FindEditLink = find_edit_link(self)
FindEditMediaLink = find_edit_media_link(self)
FindLicenseLink = find_license_link(self)
FindNextLink = find_next_link(self)
FindSelfLink = find_self_link(self)
Find the first link with rel set to 'self'
 
Returns:
  A str containing the link's href or None if none of the links had rel
  equal to 'self'
FindUrl = find_url(self, rel)
Returns the URL in a link with the desired rel value.
GetAlternateLink = get_alternate_link(self)
GetEditLink = get_edit_link(self)
GetEditMediaLink = get_edit_media_link(self)
GetLicenseLink = get_license_link(self)
GetLink = get_link(self, rel)
Returns a link object which has the desired rel value.
 
If you are interested in the URL instead of the link object,
consider using find_url instead.
GetNextLink = get_next_link(self)
GetSelfLink = get_self_link(self)
find_alternate_link(self)
find_edit_link(self)
find_edit_media_link(self)
find_license_link(self)
find_next_link(self)
find_self_link(self)
Find the first link with rel set to 'self'
 
Returns:
  A str containing the link's href or None if none of the links had rel
  equal to 'self'
find_url(self, rel)
Returns the URL in a link with the desired rel value.
get_alternate_link(self)
get_edit_link(self)
get_edit_media_link(self)
get_license_link(self)
get_link(self, rel)
Returns a link object which has the desired rel value.
 
If you are interested in the URL instead of the link object,
consider using find_url instead.
get_next_link(self)
get_self_link(self)

 
Data
        RESOURCE_COMMON_NAME_NAME = 'resourceCommonName'
RESOURCE_DESCRIPTION_NAME = 'resourceDescription'
RESOURCE_ID_NAME = 'resourceId'
RESOURCE_TYPE_NAME = 'resourceType'
__author__ = 'Vic Fryzel <vf@google.com>'

 
Author
        Vic Fryzel <vf@google.com>