Back to index

plone3  3.1.7
Public Member Functions
GroupUserFolder.interfaces.IUserFolder.IUser Class Reference
Inheritance diagram for GroupUserFolder.interfaces.IUserFolder.IUser:
Inheritance graph
[legend]
Collaboration diagram for GroupUserFolder.interfaces.IUserFolder.IUser:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def getDomains
def setPassword
def setDomains
def addDomain
def removeDomain
def getId
def getUserName
def getName
def getRoles
def getProperty
def hasProperty
def setProperty

Detailed Description

A user is a user atom who can log itself on, and
have additional properties such as domains and password.

Definition at line 562 of file IUserFolder.py.


Member Function Documentation

Append a domain for the user

Definition at line 583 of file IUserFolder.py.

00583 
00584     def addDomain(domain):
00585         """Append a domain for the user
00586         """

A user is a user atom who can log itself on, and
have additional properties such as domains and password.
Return the list of domain restrictions for a user

Definition at line 570 of file IUserFolder.py.

00570 
00571     def getDomains():
00572         """Return the list of domain restrictions for a user"""

def GroupUserFolder.interfaces.IUserFolder.IUserAtom.getId (   unprefixed = 0) [inherited]
This interface is an abstract representation of what both a User and a Group can do.
Get the ID of the user. The ID can be used, at least from
Python, to get the user from the user's UserDatabase.
If unprefixed, remove all prefixes in any case.

Definition at line 423 of file IUserFolder.py.

00423 
00424     def getId(unprefixed = 0):
00425         """Get the ID of the user. The ID can be used, at least from
00426         Python, to get the user from the user's UserDatabase.
00427         If unprefixed, remove all prefixes in any case."""

Get user's or group's name.
For a user, the name can be set by the underlying user folder but usually id == name.
For a group, the ID is prefixed, but the NAME is NOT prefixed by 'group_'.

Definition at line 432 of file IUserFolder.py.

00432 
00433     def getName():
00434         """Get user's or group's name.
00435         For a user, the name can be set by the underlying user folder but usually id == name.
00436         For a group, the ID is prefixed, but the NAME is NOT prefixed by 'group_'.
00437         """

Here is the caller graph for this function:

Get a property's value.
Will raise if not available.

Definition at line 446 of file IUserFolder.py.

00446 
00447     def getProperty(name):
00448         """Get a property's value.
00449         Will raise if not available.
00450         """

Here is the caller graph for this function:

Return the list of roles assigned to a user atom.
This will never return gruf-related roles.

Definition at line 438 of file IUserFolder.py.

00438 
00439     def getRoles():
00440         """Return the list of roles assigned to a user atom.
00441         This will never return gruf-related roles.
00442         """

Here is the caller graph for this function:

Alias for getName()

Definition at line 428 of file IUserFolder.py.

00428 
00429     def getUserName():
00430         """Alias for getName()
00431         """

Here is the caller graph for this function:

Return true if the underlying user object has a value for the property.

Definition at line 451 of file IUserFolder.py.

00451 
00452     def hasProperty(name):
00453         """Return true if the underlying user object has a value for the property.
00454         """

Here is the caller graph for this function:

Remove a domain for the user

Definition at line 587 of file IUserFolder.py.

00587 
00588     def removeDomain(domain):
00589         """Remove a domain for the user
00590         """
00591 

Replace domains for the user

Definition at line 579 of file IUserFolder.py.

00579 
00580     def setDomains(domains):
00581         """Replace domains for the user
00582         """

Set user's password

Definition at line 575 of file IUserFolder.py.

00575 
00576     def setPassword(newPassword):
00577         """Set user's password
00578         """

def GroupUserFolder.interfaces.IUserFolder.IUserAtom.setProperty (   name,
  value 
) [inherited]
Set a property's value.
As some user folders cannot set properties, this method is not guaranteed to work
and will raise a NotImplementedError if the underlying user folder cannot store
properties (or _this_ particular property) for a user.

Definition at line 457 of file IUserFolder.py.

00457 
00458     def setProperty(name, value):
00459         """Set a property's value.
00460         As some user folders cannot set properties, this method is not guaranteed to work
00461         and will raise a NotImplementedError if the underlying user folder cannot store
00462         properties (or _this_ particular property) for a user.
00463         """
        

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