Back to index

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

List of all members.

Public Member Functions

def getGroupById
def getGroups
 these interface methods are suspect for scalability.
def getGroupIds
def getGroupMembers
def addGroup
def addPrincipalToGroup
def updateGroup
def setRolesForGroup
def removeGroup
def removePrincipalFromGroup
def getGroupSpaceContainer
def setGroupSpaceCreationFlag
def getGroupSpaceForGroup
def getGroupSpaceURL
def createGroupSpace

Detailed Description

Defines an interface for managing and introspecting and
groups and group membership.

Definition at line 128 of file group.py.


Member Function Documentation

def PlonePAS.interfaces.group.IGroupManagement.addGroup (   id,
  kw 
) [inherited]
Create a group with the supplied id, roles, and groups.
return True if the operation suceeded

Definition at line 26 of file group.py.

00026 
00027     def addGroup(id, **kw):
00028         """
00029         Create a group with the supplied id, roles, and groups.
00030         return True if the operation suceeded
00031         """

Here is the caller graph for this function:

def PlonePAS.interfaces.group.IGroupManagement.addPrincipalToGroup (   self,
  principal_id,
  group_id 
) [inherited]
Add a given principal to the group.
return True on success

Definition at line 32 of file group.py.

00032 
00033     def addPrincipalToGroup(self, principal_id, group_id):
00034         """
00035         Add a given principal to the group.
00036         return True on success
00037         """

Here is the caller graph for this function:

create a groupspace for the given group id

Definition at line 112 of file group.py.

00112 
00113     def createGroupSpace(group_id):
00114         """
00115         create a groupspace for the given group id
00116         """
00117 

Returns the portal_groupdata-ish object for a group
corresponding to this id.

Definition at line 64 of file group.py.

00064 
00065     def getGroupById(group_id):
00066         """
00067         Returns the portal_groupdata-ish object for a group
00068         corresponding to this id.
00069         """

Here is the caller graph for this function:

Returns a list of the available groups

Definition at line 79 of file group.py.

00079 
00080     def getGroupIds():
00081         """
00082         Returns a list of the available groups
00083         """

Here is the caller graph for this function:

return the members of the given group

Definition at line 84 of file group.py.

00084 
00085     def getGroupMembers(group_id):
00086         """
00087         return the members of the given group
00088         """

Here is the caller graph for this function:

these interface methods are suspect for scalability.

Returns an iteration of the available groups

Definition at line 74 of file group.py.

00074 
00075     def getGroups():
00076         """
00077         Returns an iteration of the available groups
00078         """

Here is the caller graph for this function:

return the group space container

Definition at line 91 of file group.py.

00091 
00092     def getGroupSpaceContainer(self):
00093         """
00094         return the group space container
00095         """

return the groupspace for the given group id

Definition at line 102 of file group.py.

00102 
00103     def getGroupSpaceForGroup(group_id):
00104         """
00105         return the groupspace for the given group id
00106         """

return the url to the groupspace for the given group

Definition at line 107 of file group.py.

00107 
00108     def getGroupSpaceURL(group_id):
00109         """
00110         return the url to the groupspace for the given group
00111         """

Remove the given group
return True on success

Definition at line 50 of file group.py.

00050 
00051     def removeGroup(group_id):
00052         """
00053         Remove the given group
00054         return True on success
00055         """

Here is the caller graph for this function:

def PlonePAS.interfaces.group.IGroupManagement.removePrincipalFromGroup (   principal_id,
  group_id 
) [inherited]
remove the given principal from the group
return True on success

Definition at line 56 of file group.py.

00056 
00057     def removePrincipalFromGroup(principal_id, group_id):
00058         """
00059         remove the given principal from the group
00060         return True on success
00061         """

Here is the caller graph for this function:

set the creation flag, ie. whether or not to create
group spaces.

Definition at line 96 of file group.py.

00096 
00097     def setGroupSpaceCreationFlag(flag):
00098         """
00099         set the creation flag, ie. whether or not to create
00100         group spaces.
00101         """

def PlonePAS.interfaces.group.IGroupManagement.setRolesForGroup (   group_id,
  roles = () 
) [inherited]
set roles for group
return True on success

Definition at line 44 of file group.py.

00044 
00045     def setRolesForGroup(group_id, roles=()):
00046         """
00047         set roles for group
00048         return True on success
00049         """

Here is the caller graph for this function:

def PlonePAS.interfaces.group.IGroupManagement.updateGroup (   id,
  kw 
) [inherited]
Edit the given group. plugin specific
return True on success

Definition at line 38 of file group.py.

00038 
00039     def updateGroup(id, **kw):
00040         """
00041         Edit the given group. plugin specific
00042         return True on success
00043         """

Here is the caller graph for this function:


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