Package pyGlobus :: Module rlsClient :: Class RlsAttr
[show private | hide private]
[frames | no frames]

Class RlsAttr


A class to wrap the RLS globus_rls_attribute_t structure. This class should be subclassed to construct individual types and instances of attributes.
Method Summary
  __init__(self, handle)
Construct an instance.
  __del__(self)
Frees the memory associated with the handle
  __str__(self)
Formats instances for pretty printing.
  get_handle(self)
Return *handle* - the SWIG'ized globus_rls_attribute_t pointer
  get_name(self)
Get the name of an attribute instance.
  get_objtype(self)
Get the object type of an attribute instance.
  get_type(self)
Get the type of an attribute instance.
  get_val(self)
Get the value of an attribute instance.
  set_name(self, name)
Set the name for an attribute.
  set_objtype(self, objtype)
Set the object type for an attribute.
  set_type(self, type)
Set the value type for an attribute.
  set_val(self, val)
Set the value for an attribute.
  _base(self)
Return just this base class with attributes set to the current values.

Method Details

__init__(self, handle=None)
(Constructor)

Construct an instance.
Parameters:
handle - a SWIG'ized pointer to an initialized globus_rls_attribute_t structure.
Returns:

An instance of class RlsAttr.

None

__del__(self)
(Destructor)

Frees the memory associated with the handle
Returns:

None

None

__str__(self)
(Informal representation operator)

Formats instances for pretty printing.
Returns:

A string suitable for printing.

None

get_handle(self)

Returns:
*handle* - the SWIG'ized globus_rls_attribute_t pointer

get_name(self)

Get the name of an attribute instance.
Returns:

String representing the name of the attribute.

None

get_objtype(self)

Get the object type of an attribute instance.
Returns:

Integer representing the object type of the attribute.

None

get_type(self)

Get the type of an attribute instance.
Returns:

Integer representing the type of the attribute value.

None

get_val(self)

Get the value of an attribute instance.
Returns:
Value. The type depends on the attribute value type.
Raises:
RlsAttrException - A RlsAttrException is raised if the type is illegal None

set_name(self, name)

Set the name for an attribute.
Parameters:
name - String used as name for attribute
Returns:
None
Raises:
RlsAttrException - A RlsAttrException is raised if unable to set the name for the attribute.

set_objtype(self, objtype)

Set the object type for an attribute.
Parameters:
objtype -

Object type of the object to which the attribute applies. Argument must be one of

obj_lrc_lfn

obj_lrc_pfn

obj_rli_lfn

obj_rli_lrc
Returns:
None
Raises:
RlsAttrException - A RlsAttrException is raised if unable to set the object type for the attribute.

set_type(self, type)

Set the value type for an attribute.
Parameters:
type -

Type of the attribute value. Must be one of

attr_type_date

attr_type_flt

attr_type_int

attr_type_str
Returns:
None
Raises:
RlsAttrException - A RlsAttrException is raised if unable to set the type for the attribute.

set_val(self, val)

Set the value for an attribute. Also sets the type of the value
Parameters:
val - Value to which the attribute should be set
Returns:
None
Raises:
RlsAttrException - A RlsAttrException is raised if unable to set the val for the attribute.

_base(self)

Return just this base class with attributes set to the current values.
Returns:

An instance of the class RlsAttr

None

Generated by Epydoc 2.1 on Tue Apr 4 14:32:56 2006 http://epydoc.sf.net