Back to index

plone3  3.1.7
Public Member Functions
PlonePAS.interfaces.browser.IPASSearchView Class Reference
Inheritance diagram for PlonePAS.interfaces.browser.IPASSearchView:
Inheritance graph
[legend]
Collaboration diagram for PlonePAS.interfaces.browser.IPASSearchView:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def searchUsers
def searchUsersByRequest
def searchGroups
def searchGroupsByRequest

Detailed Description

Definition at line 18 of file browser.py.


Member Function Documentation

Search for groups matching a set of criteria.

The criteria are a dictionary mapping group properties
to values and have the semantics declared by
IPluggableAuthService.searchGroups().

Definition at line 55 of file browser.py.

00055 
00056     def searchGroups(**criteria):
00057         """Search for groups matching a set of criteria.
00058 
00059         The criteria are a dictionary mapping group properties
00060         to values and have the semantics declared by
00061         IPluggableAuthService.searchGroups().
00062         """
00063 

Here is the caller graph for this function:

Search for groups matching a set of criteria found in a request.

This method will look remove any obvious values from the request
which are not search criteria. It will also remove any fields
which have an empty string value.

Definition at line 64 of file browser.py.

00064 
00065     def searchGroupsByRequest(request):
00066         """Search for groups matching a set of criteria found in a request.
00067 
00068         This method will look remove any obvious values from the request
00069         which are not search criteria. It will also remove any fields
00070         which have an empty string value.
00071         """
def PlonePAS.interfaces.browser.IPASSearchView.searchUsers (   sort_by = None,
  any_field = None,
  criteria 
)
Search for users matching a set of criteria.

The criteria are a dictionary mapping user properties to values and
have the semantics declared by IPluggableAuthService.searchUsers().
Duplicate results returned by PAS are filtered so only the first
result remains in the result set. The results can be sorted on
sort_bys (case insensitive).

In addition, a single search string can be sought in multiple
fields at a time by passing any_field='your-string'. The fields
that will be searched are not explicitly enumerated but will be the
user-facing ones a user would expect to search, such as login name
and full name. (Perhaps any_field should/could be moved into PAS
proper. This could be done without breaking code that depends on
this interface.)

If you specify both any_field and other criteria that include a
field that any_field would typically search (such as login name),
the other criteria will be enforced at the expense of any_field.

Definition at line 20 of file browser.py.

00020 
00021     def searchUsers(sort_by=None, any_field=None, **criteria):
00022         """Search for users matching a set of criteria.
00023 
00024         The criteria are a dictionary mapping user properties to values and
00025         have the semantics declared by IPluggableAuthService.searchUsers().
00026         Duplicate results returned by PAS are filtered so only the first
00027         result remains in the result set. The results can be sorted on
00028         sort_bys (case insensitive).
00029         
00030         In addition, a single search string can be sought in multiple
00031         fields at a time by passing any_field='your-string'. The fields
00032         that will be searched are not explicitly enumerated but will be the
00033         user-facing ones a user would expect to search, such as login name
00034         and full name. (Perhaps any_field should/could be moved into PAS
00035         proper. This could be done without breaking code that depends on
00036         this interface.)
00037         
00038         If you specify both any_field and other criteria that include a
00039         field that any_field would typically search (such as login name),
00040         the other criteria will be enforced at the expense of any_field.
00041         """
00042 

Here is the caller graph for this function:

def PlonePAS.interfaces.browser.IPASSearchView.searchUsersByRequest (   request,
  sort_by = None 
)
Search for users matching a set of criteria found in a request.

This method will look remove any obvious values from the request
which are not search criteria. It will also remove any fields
which have an empty string value.
Duplicate results returned by PAS are filtered so only the first
result remains in the result set. The results can be sorted on
sort_by (case insensitive).

Definition at line 43 of file browser.py.

00043 
00044     def searchUsersByRequest(request, sort_by=None):
00045         """Search for users matching a set of criteria found in a request.
00046 
00047         This method will look remove any obvious values from the request
00048         which are not search criteria. It will also remove any fields
00049         which have an empty string value.
00050         Duplicate results returned by PAS are filtered so only the first
00051         result remains in the result set. The results can be sorted on
00052         sort_by (case insensitive).
00053         """
00054 


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