Back to index

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

List of all members.

Public Member Functions

def addPropertysheet
def listPropertysheets
def getPropertysheet
def getId
def getUserName
def getRoles
def getRolesInContext
def getDomains

Detailed Description

A user which has property sheets associated with it,
    i.e. a mapping from strings (property sheet ids)
    to objects implementing IPropertySheet

Definition at line 71 of file authservice.py.


Member Function Documentation

A user which has property sheets associated with it,
i.e. a mapping from strings (property sheet ids)
to objects implementing IPropertySheet
Add a new property sheet to the user.

The property sheet has to be a map or an IPropertySheet instance.

Definition at line 78 of file authservice.py.

00078 
00079     def addPropertysheet( id, data ):
00080         
00081         """ Add a new property sheet to the user.
00082 
00083         The property sheet has to be a map or an IPropertySheet instance.
00084         """

Return the list of domain restrictions for a user.

Definition at line 65 of file authservice.py.

00065 
00066     def getDomains():
00067 
00068         """ Return the list of domain restrictions for a user.
00069         """
00070 

Get the ID of the user.

o The ID can be used, at least from Python, to get the user from
  the user's UserDatabase

Definition at line 34 of file authservice.py.

00034 
00035     def getId():
00036 
00037         """ Get the ID of the user.
00038 
00039         o The ID can be used, at least from Python, to get the user from
00040           the user's UserDatabase
00041         """

Return a property sheet for the given id

o the returned object implements IPropertySheet
  and has the same id as the value passed to this method

o if there is no property sheet for the given id,
  raise a KeyError

  An alternative way to get the property sheet is via item access,
  i.e. user.getPropertysheet( id ) == user[ id ]

Definition at line 93 of file authservice.py.

00093 
00094     def getPropertysheet( id ):
00095 
00096         """ Return a property sheet for the given id
00097 
00098         o the returned object implements IPropertySheet
00099           and has the same id as the value passed to this method
00100 
00101         o if there is no property sheet for the given id,
00102           raise a KeyError
00103 
00104           An alternative way to get the property sheet is via item access,
00105           i.e. user.getPropertysheet( id ) == user[ id ]
00106         """
00107 

Return the roles assigned to a user "globally".

Definition at line 51 of file authservice.py.

00051 
00052     def getRoles():
00053 
00054         """ Return the roles assigned to a user "globally".
00055         """

Here is the caller graph for this function:

Return the roles assigned to the user in context of 'object'.

o Roles include both global roles (ones assigned to the user
  directly inside the user folder) and local roles (assigned
  in context of the passed in object.

Definition at line 56 of file authservice.py.

00056 
00057     def getRolesInContext( object ):
00058 
00059         """ Return the roles assigned to the user in context of 'object'.
00060 
00061         o Roles include both global roles (ones assigned to the user
00062           directly inside the user folder) and local roles (assigned
00063           in context of the passed in object.
00064         """

Return the name used by the user to log into the system.

o Note that this may not be identical to the user's 'getId'
  (to allow users to change their login names without changing
  their identity).

Definition at line 42 of file authservice.py.

00042 
00043     def getUserName():
00044 
00045         """ Return the name used by the user to log into the system.
00046 
00047         o Note that this may not be identical to the user's 'getId'
00048           (to allow users to change their login names without changing
00049           their identity).
00050         """

Here is the caller graph for this function:

Return a sequence of property sheet ids

o for each id in the list getPropertysheet(id)
  returns a IPropertySheet

Definition at line 85 of file authservice.py.

00085 
00086     def listPropertysheets():
00087 
00088         """ Return a sequence of property sheet ids
00089 
00090         o for each id in the list getPropertysheet(id)
00091           returns a IPropertySheet
00092         """


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