Back to index

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

List of all members.

Public Member Functions

def getPropertiesForUser
def setPropertiesForUser
def deleteUser

Detailed Description

Return a property set for a user. Property set can either an
object conforming to the IMutable property sheet interface or a
dictionary (in which case the properties are not persistently
mutable).

Definition at line 103 of file plugins.py.


Member Function Documentation

Remove properties stored for a user

Definition at line 131 of file plugins.py.

00131 
00132     def deleteUser(user_id):
00133         """
00134         Remove properties stored for a user
00135         """
00136 

Return a property set for a user. Property set can either an
object conforming to the IMutable property sheet interface or a
dictionary (in which case the properties are not persistently
mutable).
User -> IMutablePropertySheet || {}

o User will implement IPropertiedUser.

o Plugin may scribble on the user, if needed (but must still
  return a mapping, even if empty).

o May assign properties based on values in the REQUEST object, if
  present

Definition at line 111 of file plugins.py.

00111 
00112     def getPropertiesForUser(user, request=None):
00113         """
00114         User -> IMutablePropertySheet || {}
00115 
00116         o User will implement IPropertiedUser.
00117 
00118         o Plugin may scribble on the user, if needed (but must still
00119           return a mapping, even if empty).
00120 
00121         o May assign properties based on values in the REQUEST object, if
00122           present
00123         """

Set modified properties on the user persistently.

Raise a ValueError if the property or property value is invalid

Definition at line 124 of file plugins.py.

00124 
00125     def setPropertiesForUser(user, propertysheet):
00126         """
00127         Set modified properties on the user persistently.
00128 
00129         Raise a ValueError if the property or property value is invalid
00130         """


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