Table of Contents

Class: EntrySet ./pyGlobus/replicaCatalog.py

The main interface to the replica catatlog entry set module.

Manages access to the entry set, and hides the underlying memory management.

Methods   
__del__
__getitem__
__init__
__len__
count
first
get_attributes
get_dn
get_handle
get_name
get_url
more
next
  __del__ 
__del__ ( self )

Destroys an instance.

It will destroy the entry set, and free the underlying memory.

Raises:

A EntrySetException is thrown if unable to destroy the entry set. This exception can't be caught, and should never happend. It's there mainly for debugging if it does happen. :-)

Exceptions   
ex
  __getitem__ 
__getitem__ ( self,  index )

Limited sequence operator.

Allows normal python list iteration. Returns the attribute set associated with each entry.

Exceptions   
IndexException
  __init__ 
__init__ ( self,  handle )

Construct an instance.

This will construct an instance from a given handle. This constructor. is for module use, and should not be called. Instead calls like Collection.list_collections() returns an entry set instance.

Arguments

  • handle A SWIG'ized pointer to a globus_replica_catalog_collection_entry_set.

  __len__ 
__len__ ( self )

Returns the length of the set.

  count 
count ( self )

Get the number of entries in the entry set.

Returns

The number of entries is returned.

Raises

An EntrySetException is thrown if unable to return the number of entries.

Exceptions   
ex
  first 
first ( self )

Set the current entry to the first entry in the set.

Raises

An EntrySetException is thrown if unable to reset the current entry.

Exceptions   
ex
  get_attributes 
get_attributes ( self )

Return the attribute set of the current entry in the set.

Must have been preceded by a call to get_first().

Retuns

An AttributeSet object containg the attributes is returned.

Raises

An EntrySetException is thrown if unable to return the AttributeSet.

Exceptions   
ex
  get_dn 
get_dn ( self )

Get the DN of the current entry in an entry set.

Must be preceded by a call to first.

Returns

A string containing the DN of the current entry is returned.

Raises

An EntrySetException is thrown if unable to return the DN.

Exceptions   
ex
  get_handle 
get_handle ( self )

Return the underlying replica catalog entry set handle.

XXX This handle is only valid as long as this object exists. When the object is destroyed, the memory this handle points to is freed.

Returns:

A string containing the pointer.

  get_name 
get_name ( self )

Get the name of the current entry in an entry set.

Must be preceded by a call to first.

Retuns

A string is returned containing the name of the current entry.

Raises

An EntrySetException is thrown if unable to get the name.

Exceptions   
ex
  get_url 
get_url ( self )

Get the URL of the current entry in an entry set.

Must be preceded by a call to first.

Returns

A string containing the url of the current entry is returned.

Raises

An EntrySetException is thrown if unable to return the url.

Exceptions   
ex
  more 
more ( self )

Whether there are more entries in an entry set, inclusive of the current entry.

Must be preceded by a call to first.

Returns

Returns true if there are more entries, and false if none.

Raises

An EntrySetException is thrown if an error occurs.

  next 
next ( self )

Set the current entry to the next entry in the set.

Must be preceded by a call to first.

Raises

An EntrySetException is thrown if unable to reset the current entry.

Exceptions   
ex

Table of Contents

This document was automatically generated on Tue Feb 4 16:47:03 2003 by HappyDoc version 2.1