|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GroupManager
Manages groups.
In some cases, you may wish to plug in your own group system implementation. In that case, you should set the Jive property GroupManager.className with the name of your GroupManager class. Your class must have a public, no-argument constructor. The class must also create and return Group object implementations as necessary.
Group
Method Summary | |
---|---|
Group |
createGroup(java.lang.String name)
Factory method for creating a new Group. |
void |
deleteGroup(Group group)
Deletes a group from the system. |
Group |
getGroup(long groupID)
Gets a Group by ID. |
Group |
getGroup(java.lang.String name)
Gets a Group by name. |
int |
getGroupCount()
Returns the total number of groups in the system. |
com.jivesoftware.util.LongList |
getGroupIDs(User user)
Returns a list of group ids for all the groups that the user is a member of. |
java.util.Iterator |
getGroups()
Returns an iterator for all groups in the system. |
java.util.Iterator |
getGroups(int startIndex,
int numResults)
Returns an iterator for all groups starting at startIndex with the given number of results. |
java.util.Iterator |
getUserGroups(User user)
Returns an iterator for all groups that a user is a member of. |
Method Detail |
---|
Group createGroup(java.lang.String name) throws GroupAlreadyExistsException
name
- the new and unique name for the group.
GroupAlreadyExistsException
- if the group name already exists in the system.Group getGroup(long groupID) throws GroupNotFoundException
GroupNotFoundException
Group getGroup(java.lang.String name) throws GroupNotFoundException
GroupNotFoundException
void deleteGroup(Group group) throws UnauthorizedException
group
- the group to delete.
UnauthorizedException
- if not a system administrator.int getGroupCount()
java.util.Iterator getGroups()
java.util.Iterator getGroups(int startIndex, int numResults)
startIndex
- the beginning index to start the results at.numResults
- the total number of results to return.
java.util.Iterator getUserGroups(User user)
user
- the user to get a list of groups for.
com.jivesoftware.util.LongList getGroupIDs(User user)
user
- the user to get a list of groups for.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |