|
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 |
public interface GroupService
Provides a the ability for managing groups and group membership.
Method Summary | |
---|---|
void |
addAdministratorToGroup(long userID,
long groupID)
Make the user with the specified userID an administrator of the group with the specified groupID. |
void |
addMemberToGroup(long userID,
long groupID)
Add the user with the specified userID to the group with the specified groupID. |
Group |
createGroup(java.lang.String name,
java.lang.String description)
Creates a new group. |
void |
deleteGroup(long groupID)
Delete the group with the specified id. |
void |
deleteProperty(java.lang.String name,
long groupID)
Deletes an extended property from the specfied group. |
int |
getAdministratorCount(long groupID)
Returns the count of how many administrators there are for the group with the specified ID. |
Group |
getGroup(long groupID)
Returns a Group by its ID. |
User[] |
getGroupAdmins(long groupID)
Returns an array of all the user IDs that administer this group. |
Group |
getGroupByName(java.lang.String name)
Returns a Group by its name. |
int |
getGroupCount()
Returns a count of all groups in the system. |
User[] |
getGroupMembers(long groupID)
Returns an array of all userIDs for all the members of a particular group. |
Group[] |
getGroups()
Returns an array of all the group IDs for all the groups in the system. |
Property[] |
getProperties(long groupID)
Returns an array of all the extended properties for a group. |
Group[] |
getUserGroups(long userID)
Returns an array of all the group IDs that a user belongs too. |
void |
removeAdministratorFromGroup(long userID,
long groupID)
Remove the user with the specified ID as an administrator from the group with the specified ID. |
void |
removeMemberFromGroup(long userID,
long groupID)
Remove the user with the specified id from the group with the specified id. |
void |
setProperty(java.lang.String name,
java.lang.String value,
long groupID)
Set a new extended property on the specified group. |
void |
updateGroup(Group group)
Update the following group in the system. |
Method Detail |
---|
Group getGroup(long groupID) throws GroupNotFoundException
Group
by its ID.
groupID
- The ID of the group.
GroupNotFoundException
Group getGroupByName(java.lang.String name) throws GroupNotFoundException
Group
by its name.
name
- The name of the group.
GroupNotFoundException
User[] getGroupMembers(long groupID) throws GroupNotFoundException
groupID
- The ID of the group to acquire members for.
GroupNotFoundException
int getGroupCount()
Group[] getGroups()
Group[] getUserGroups(long userID) throws UserNotFoundException
userID
- The ID of the user to acquire group IDs for.
UserNotFoundException
User[] getGroupAdmins(long groupID) throws GroupNotFoundException
groupID
- The group ID to acquire administrator IDs for.
GroupNotFoundException
int getAdministratorCount(long groupID) throws GroupNotFoundException
groupID
- The ID of the group to acquire the administrator count for.
GroupNotFoundException
Group createGroup(java.lang.String name, java.lang.String description) throws GroupAlreadyExistsException
name
- The name of the group.description
- A short description of this group.
GroupAlreadyExistsException
void deleteGroup(long groupID) throws GroupNotFoundException
groupID
- The id of the group to delete.
GroupNotFoundException
void updateGroup(Group group) throws GroupNotFoundException
group
- The group to update.
GroupNotFoundException
Property[] getProperties(long groupID) throws GroupNotFoundException
groupID
- The ID of the group to acquire extended properties for.
GroupNotFoundException
void setProperty(java.lang.String name, java.lang.String value, long groupID) throws GroupNotFoundException
name
- The extended property name.value
- The extended property value.groupID
- The ID of the group to set the extended property on.
GroupNotFoundException
void deleteProperty(java.lang.String name, long groupID) throws GroupNotFoundException
name
- The name of the extended property to delete.groupID
- The id of the group to delete an extended property from.
GroupNotFoundException
void addMemberToGroup(long userID, long groupID) throws UserNotFoundException, GroupNotFoundException
userID
- The ID of the user to add to a group.groupID
- The ID of the group to add a user too.
UserNotFoundException
GroupNotFoundException
void addAdministratorToGroup(long userID, long groupID) throws UserNotFoundException, GroupNotFoundException
userID
- The ID of the user to add as a member to a group.groupID
- The ID of the group to make a user an administrator for.
UserNotFoundException
GroupNotFoundException
void removeMemberFromGroup(long userID, long groupID) throws UserNotFoundException, GroupNotFoundException
userID
- The ID of the User to remove from a group.groupID
- The ID of the group to remove a user from.
UserNotFoundException
GroupNotFoundException
void removeAdministratorFromGroup(long userID, long groupID) throws UserNotFoundException, GroupNotFoundException
userID
- The ID of the user to remove admin status from a group.groupID
- The ID of the group to remove the user as an admin.
UserNotFoundException
GroupNotFoundException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |