|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.base.GroupManagerAdapter
public abstract class GroupManagerAdapter
Constructor Summary | |
---|---|
GroupManagerAdapter()
|
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. |
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. |
boolean |
isCreateGroupSupported()
Indicates whether the GroupManager supports creating groups via the createGroups() method. |
boolean |
isDeleteGroupSupported()
Indicates whether the GroupManager supports deleting groups via the deleteGroups() method. |
boolean |
isGetUserGroupsSupported()
Indicates whether the GroupManager supports getting a listing of all groups for a given user via the getUserGroups() method. |
boolean |
isGroupListSupported()
Indicates whether the GroupManager supports getting a listing of all groups via the getGroups() method. |
boolean |
isReadOnly()
|
protected abstract Group |
lookupGroup(long groupID)
|
protected abstract Group |
lookupGroup(java.lang.String name)
|
protected abstract long[] |
lookupGroupsForUser(User user)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GroupManagerAdapter()
Method Detail |
---|
public Group createGroup(java.lang.String name) throws GroupAlreadyExistsException
GroupManager
createGroup
in interface GroupManager
name
- the new and unique name for the group.
GroupAlreadyExistsException
- if the group name already exists in the system.public void deleteGroup(Group group) throws UnauthorizedException
GroupManager
deleteGroup
in interface GroupManager
group
- the group to delete.
UnauthorizedException
- if not a system administrator.public int getGroupCount()
GroupManager
getGroupCount
in interface GroupManager
public java.util.Iterator getGroups()
GroupManager
getGroups
in interface GroupManager
public java.util.Iterator getGroups(int startIndex, int numResults)
GroupManager
getGroups
in interface GroupManager
startIndex
- the beginning index to start the results at.numResults
- the total number of results to return.
public Group getGroup(long groupID) throws GroupNotFoundException
GroupManager
getGroup
in interface GroupManager
GroupNotFoundException
public Group getGroup(java.lang.String name) throws GroupNotFoundException
GroupManager
getGroup
in interface GroupManager
GroupNotFoundException
public java.util.Iterator getUserGroups(User user)
GroupManager
getUserGroups
in interface GroupManager
user
- the user to get a list of groups for.
public LongList getGroupIDs(User user)
GroupManager
getGroupIDs
in interface GroupManager
user
- the user to get a list of groups for.
protected abstract long[] lookupGroupsForUser(User user)
protected abstract Group lookupGroup(java.lang.String name) throws GroupNotFoundException
GroupNotFoundException
protected abstract Group lookupGroup(long groupID) throws GroupNotFoundException
GroupNotFoundException
public boolean isCreateGroupSupported()
IntrospectiveGroupManager
isCreateGroupSupported
in interface IntrospectiveGroupManager
public boolean isDeleteGroupSupported()
IntrospectiveGroupManager
isDeleteGroupSupported
in interface IntrospectiveGroupManager
public boolean isGroupListSupported()
IntrospectiveGroupManager
isGroupListSupported
in interface IntrospectiveGroupManager
public boolean isGetUserGroupsSupported()
IntrospectiveGroupManager
isGetUserGroupsSupported
in interface IntrospectiveGroupManager
public boolean isReadOnly()
isReadOnly
in interface IntrospectiveGroupManager
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |