Back to index

plone3  3.1.7
Public Member Functions
PluggableAuthService.interfaces.propertysheets.IPropertySheet Class Reference
Inheritance diagram for PluggableAuthService.interfaces.propertysheets.IPropertySheet:
Inheritance graph
[legend]
Collaboration diagram for PluggableAuthService.interfaces.propertysheets.IPropertySheet:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def getId
def hasProperty
def getProperty
def getPropertyType
def propertyInfo
def propertyMap
def propertyIds
def propertyValues
def propertyItems

Detailed Description

Interface for queryable property sheets.

o Objects implementing this interface can play in read-only fashion
  in OFS.PropertySheets' framework.

Definition at line 25 of file propertysheets.py.


Member Function Documentation

Identify the sheet within a collection.

Definition at line 33 of file propertysheets.py.

00033 
00034     def getId():
00035 
00036         """ Identify the sheet within a collection.
00037         """

Return the value of the property corresponding to 'id'.

o If no such property exists within the sheet, return 'default'.

Definition at line 43 of file propertysheets.py.

00043 
00044     def getProperty( id, default=None ):
00045 
00046         """ Return the value of the property corresponding to 'id'.
00047 
00048         o If no such property exists within the sheet, return 'default'.
00049         """

Here is the caller graph for this function:

Return the string identifying the type of property, 'id'.

o If no such property exists within the sheet, return None.

Definition at line 50 of file propertysheets.py.

00050 
00051     def getPropertyType( id ):
00052 
00053         """ Return the string identifying the type of property, 'id'.
00054 
00055         o If no such property exists within the sheet, return None.
00056         """

Does the sheet have a property corresponding to 'id'?

Definition at line 38 of file propertysheets.py.

00038 
00039     def hasProperty( id ):
00040 
00041         """ Does the sheet have a property corresponding to 'id'?
00042         """

Here is the caller graph for this function:

Return a sequence of the IDs of the sheet's properties.

Definition at line 75 of file propertysheets.py.

00075 
00076     def propertyIds():
00077 
00078         """ Return a sequence of the IDs of the sheet's properties.
00079         """

Here is the caller graph for this function:

Return a mapping describing property, 'id'.

o Keys must include:

  'id'  -- the unique identifier of the property.

  'type' -- the string identifying the property type.

  'meta' -- a mapping containing additional info about the property.

Definition at line 57 of file propertysheets.py.

00057 
00058     def propertyInfo( id ):
00059 
00060         """ Return a mapping describing property, 'id'.
00061 
00062         o Keys must include:
00063 
00064           'id'  -- the unique identifier of the property.
00065 
00066           'type' -- the string identifying the property type.
00067 
00068           'meta' -- a mapping containing additional info about the property.
00069         """

Return a sequence of ( id, value ) tuples, one per property.

Definition at line 85 of file propertysheets.py.

00085 
00086     def propertyItems():
00087 
00088         """ Return a sequence of ( id, value ) tuples, one per property.
00089         """

Here is the caller graph for this function:

Return a tuple of 'propertyInfo' mappings, one per property.

Definition at line 70 of file propertysheets.py.

00070 
00071     def propertyMap():
00072 
00073         """ Return a tuple of 'propertyInfo' mappings, one per property.
00074         """

Return a sequence of the values of the sheet's properties.

Definition at line 80 of file propertysheets.py.

00080 
00081     def propertyValues():
00082 
00083         """ Return a sequence of the values of the sheet's properties.
00084         """


The documentation for this class was generated from the following file: