Back to index

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

List of all members.

Public Member Functions

def setProperties
def getProperty
def getProperties
def getGroupId
def getMemberId
def getGroupName
def getGroupMembers
def getAllGroupMembers
def getGroupMemberIds
def getAllGroupMemberIds
def addMember
def removeMember
def getGroup

Detailed Description

An abstract interface for accessing properties on a group object

Definition at line 48 of file portal_groupdata.py.


Member Function Documentation

Add the existing member with the given id to the group

Definition at line 85 of file portal_groupdata.py.

00085 
00086     def addMember(id):
00087         """ Add the existing member with the given id to the group"""

Return a list of the user ids of the group.
including transitive ones (ie. users or groups of a group in that group).

Definition at line 81 of file portal_groupdata.py.

00081 
00082     def getAllGroupMemberIds():
00083         """ Return a list of the user ids of the group.
00084         including transitive ones (ie. users or groups of a group in that group)."""

Return a list of the portal_memberdata-ish members of the group
including transitive ones (ie. users or groups of a group in that group).

Definition at line 74 of file portal_groupdata.py.

00074 
00075     def getAllGroupMembers():
00076         """ Return a list of the portal_memberdata-ish members of the group
00077         including transitive ones (ie. users or groups of a group in that group)."""

Returns the actual group implementation. Varies by group
implementation (GRUF/Nux/et al).

Definition at line 91 of file portal_groupdata.py.

00091 
00092     def getGroup():
00093         """ Returns the actual group implementation. Varies by group
00094         implementation (GRUF/Nux/et al)."""

Here is the caller graph for this function:

Return the string id of this group, WITHOUT group prefix.

Definition at line 61 of file portal_groupdata.py.

00061 
00062     def getGroupId():
00063         """ Return the string id of this group, WITHOUT group prefix."""

Return a list of the user ids of the group.

Definition at line 78 of file portal_groupdata.py.

00078 
00079     def getGroupMemberIds():
00080         """ Return a list of the user ids of the group."""

Return a list of the portal_memberdata-ish members of the group.

Definition at line 71 of file portal_groupdata.py.

00071 
00072     def getGroupMembers():
00073         """ Return a list of the portal_memberdata-ish members of the group."""

Here is the caller graph for this function:

Return the name of the group.

Definition at line 68 of file portal_groupdata.py.

00068 
00069     def getGroupName():
00070         """ Return the name of the group."""

This exists only for a basic user/group API compatibility

Definition at line 64 of file portal_groupdata.py.

00064 
00065     def getMemberId():
00066         """This exists only for a basic user/group API compatibility
00067         """

Return the properties of this group. Properties are as usual in Zope.

Definition at line 58 of file portal_groupdata.py.

00058 
00059     def getProperties():
00060         """ Return the properties of this group. Properties are as usual in Zope."""

Return the value of the property specified by 'id' 

Definition at line 55 of file portal_groupdata.py.

00055 
00056     def getProperty(id):
00057         """ Return the value of the property specified by 'id' """

Here is the caller graph for this function:

Remove the member with the provided id from the group 

Definition at line 88 of file portal_groupdata.py.

00088 
00089     def removeMember(id):
00090         """ Remove the member with the provided id from the group """

Allows setting of group properties en masse.
Properties can be given either as a dict or a keyword parameters list

Definition at line 51 of file portal_groupdata.py.

00051 
00052     def setProperties(properties=None, **kw):
00053         """Allows setting of group properties en masse.
00054         Properties can be given either as a dict or a keyword parameters list"""


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