Back to index

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

List of all members.

Public Member Functions

def enumerateGroups

Detailed Description

Allow querying groups by ID, and searching for groups.

o XXX:  can these be done by a single plugin?

Definition at line 350 of file plugins.py.


Member Function Documentation

def PluggableAuthService.interfaces.plugins.IGroupEnumerationPlugin.enumerateGroups (   id = None,
  exact_match = False,
  sort_by = None,
  max_results = None,
  kw 
)
Allow querying groups by ID, and searching for groups.

o XXX:  can these be done by a single plugin?
-> ( group_info_1, ... group_info_N )

o Return mappings for groups 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 groups satisfying the 
  criteria.

o Minimal keys in the returned mappings:

  'id' -- (required) the group ID

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

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

  'members_url' -- (optional) the URL to a page for updating the
           principals who belong to the group.

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 362 of file plugins.py.

00362 
00363                        ):
00364 
00365         """ -> ( group_info_1, ... group_info_N )
00366 
00367         o Return mappings for groups matching the given criteria.
00368 
00369         o 'id' in combination with 'exact_match' true, will
00370           return at most one mapping per supplied ID ('id' and 'login'
00371           may be sequences).
00372 
00373         o If 'exact_match' is False, then 'id' may be treated by 
00374           the plugin as "contains" searches (more complicated searches 
00375           may be supported by some plugins using other keyword arguments).
00376 
00377         o If 'sort_by' is passed, the results will be sorted accordingly.
00378           known valid values are 'id' (some plugins may support others).
00379 
00380         o If 'max_results' is specified, it must be a positive integer,
00381           limiting the number of returned mappings.  If unspecified, the
00382           plugin should return mappings for all groups satisfying the 
00383           criteria.
00384 
00385         o Minimal keys in the returned mappings:
00386         
00387           'id' -- (required) the group ID
00388 
00389           'pluginid' -- (required) the plugin ID (as returned by getId())
00390 
00391           'properties_url' -- (optional) the URL to a page for updating the
00392                               group's properties.
00393 
00394           'members_url' -- (optional) the URL to a page for updating the
00395                            principals who belong to the group.
00396 
00397         o Plugin *must* ignore unknown criteria.
00398 
00399         o Plugin may raise ValueError for invalid critera.
00400 
00401         o Insufficiently-specified criteria may have catastrophic
00402           scaling issues for some implementations.
00403         """


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