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

Contains the data classes of the OpenSearch Extension

 
Modules
       
atom

 
Classes
       
atom.core.XmlElement(__builtin__.object)
ItemsPerPage
StartIndex
TotalResults

 
class ItemsPerPage(atom.core.XmlElement)
    Describes the number of items that will be returned per page for paged feeds
 
 
Method resolution order:
ItemsPerPage
atom.core.XmlElement
__builtin__.object

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 StartIndex(atom.core.XmlElement)
    Describes the starting index of the contained entries for paged feeds
 
 
Method resolution order:
StartIndex
atom.core.XmlElement
__builtin__.object

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 TotalResults(atom.core.XmlElement)
    Describes the total number of results associated with this feed
 
 
Method resolution order:
TotalResults
atom.core.XmlElement
__builtin__.object

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

 
Data
        OPENSEARCH_TEMPLATE_V1 = '{http://a9.com/-/spec/opensearchrss/1.0//}%s'
OPENSEARCH_TEMPLATE_V2 = '{http://a9.com/-/spec/opensearch/1.1//}%s'
__author__ = 'j.s@google.com (Jeff Scudder)'

 
Author
        j.s@google.com (Jeff Scudder)