Back to index

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

List of all members.

Public Member Functions

def enumerateRoles

Detailed Description

Allow querying roles by ID, and searching for roles.

Definition at line 404 of file plugins.py.


Member Function Documentation

def PluggableAuthService.interfaces.plugins.IRoleEnumerationPlugin.enumerateRoles (   id = None,
  exact_match = False,
  sort_by = None,
  max_results = None,
  kw 
)
Allow querying roles by ID, and searching for roles.
-> ( role_info_1, ... role_info_N )

o Return mappings for roles matching the given criteria.

o 'id' in combination with 'exact_match' true, will
  return at most one mapping per supplied ID ('id' and 'login'
  may be sequences).

o If 'exact_match' is False, then 'id' may be treated by 
  the plugin as "contains" searches (more complicated searches 
  may be supported by some plugins using other keyword arguments).

o If 'sort_by' is passed, the results will be sorted accordingly.
  known valid values are 'id' (some plugins may support others).

o If 'max_results' is specified, it must be a positive integer,
  limiting the number of returned mappings.  If unspecified, the
  plugin should return mappings for all roles satisfying the 
  criteria.

o Minimal keys in the returned mappings:

  'id' -- (required) the role ID

  'pluginid' -- (required) the plugin ID (as returned by getId())

  'properties_url' -- (optional) the URL to a page for updating the
              role's properties.

  'members_url' -- (optional) the URL to a page for updating the
           principals to whom the role is assigned.

o Plugin *must* ignore unknown criteria.

o Plugin may raise ValueError for invalid critera.

o Insufficiently-specified criteria may have catastrophic
  scaling issues for some implementations.

Definition at line 413 of file plugins.py.

00413 
00414                       ):
00415 
00416         """ -> ( role_info_1, ... role_info_N )
00417 
00418         o Return mappings for roles matching the given criteria.
00419 
00420         o 'id' in combination with 'exact_match' true, will
00421           return at most one mapping per supplied ID ('id' and 'login'
00422           may be sequences).
00423 
00424         o If 'exact_match' is False, then 'id' may be treated by 
00425           the plugin as "contains" searches (more complicated searches 
00426           may be supported by some plugins using other keyword arguments).
00427 
00428         o If 'sort_by' is passed, the results will be sorted accordingly.
00429           known valid values are 'id' (some plugins may support others).
00430 
00431         o If 'max_results' is specified, it must be a positive integer,
00432           limiting the number of returned mappings.  If unspecified, the
00433           plugin should return mappings for all roles satisfying the 
00434           criteria.
00435 
00436         o Minimal keys in the returned mappings:
00437         
00438           'id' -- (required) the role ID
00439 
00440           'pluginid' -- (required) the plugin ID (as returned by getId())
00441 
00442           'properties_url' -- (optional) the URL to a page for updating the
00443                               role's properties.
00444 
00445           'members_url' -- (optional) the URL to a page for updating the
00446                            principals to whom the role is assigned.
00447 
00448         o Plugin *must* ignore unknown criteria.
00449 
00450         o Plugin may raise ValueError for invalid critera.
00451 
00452         o Insufficiently-specified criteria may have catastrophic
00453           scaling issues for some implementations.
00454         """


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