com.jivesoftware.forum.webservices
Interface GroupService

All Known Implementing Classes:

GroupServiceImpl

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

getGroup

Group getGroup(long groupID)
               throws GroupNotFoundException

Returns a Group by its ID.

Parameters:

groupID - The ID of the group.

Returns:

The group that matches the ID specified.

Throws:

GroupNotFoundException

getGroupByName

Group getGroupByName(java.lang.String name)
                     throws GroupNotFoundException

Returns a Group by its name.

Parameters:

name - The name of the group.

Returns:

The group with the matching name.

Throws:

GroupNotFoundException

getGroupMembers

User[] getGroupMembers(long groupID)
                       throws GroupNotFoundException

Returns an array of all userIDs for all the members of a particular group.

Parameters:

groupID - The ID of the group to acquire members for.

Returns:

A array of user IDs.

Throws:

GroupNotFoundException

getGroupCount

int getGroupCount()

Returns a count of all groups in the system.

Returns:

A count of all groups in the system.

getGroups

Group[] getGroups()

Returns an array of all the group IDs for all the groups in the system.

Returns:

An array of all the group IDs for all the groups in the system.

getUserGroups

Group[] getUserGroups(long userID)
                      throws UserNotFoundException

Returns an array of all the group IDs that a user belongs too.

Parameters:

userID - The ID of the user to acquire group IDs for.

Returns:

An array of all the group IDs that a user belongs too.

Throws:

UserNotFoundException

getGroupAdmins

User[] getGroupAdmins(long groupID)
                      throws GroupNotFoundException

Returns an array of all the user IDs that administer this group.

Parameters:

groupID - The group ID to acquire administrator IDs for.

Returns:

An array of all the user IDs that administer this group.

Throws:

GroupNotFoundException

getAdministratorCount

int getAdministratorCount(long groupID)
                          throws GroupNotFoundException

Returns the count of how many administrators there are for the group with the specified ID.

Parameters:

groupID - The ID of the group to acquire the administrator count for.

Returns:

The number of administrators in the group.

Throws:

GroupNotFoundException

createGroup

Group createGroup(java.lang.String name,
                  java.lang.String description)
                  throws GroupAlreadyExistsException

Creates a new group.

Parameters:

name - The name of the group.

description - A short description of this group.

Returns:

The newly created group.

Throws:

GroupAlreadyExistsException

deleteGroup

void deleteGroup(long groupID)
                 throws GroupNotFoundException

Delete the group with the specified id.

Parameters:

groupID - The id of the group to delete.

Throws:

GroupNotFoundException

updateGroup

void updateGroup(Group group)
                 throws GroupNotFoundException

Update the following group in the system.

Parameters:

group - The group to update.

Throws:

GroupNotFoundException

getProperties

Property[] getProperties(long groupID)
                         throws GroupNotFoundException

Returns an array of all the extended properties for a group.

Parameters:

groupID - The ID of the group to acquire extended properties for.

Returns:

An array of extended properties for the specified group.

Throws:

GroupNotFoundException

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value,
                 long groupID)
                 throws GroupNotFoundException

Set a new extended property on the specified group.

Parameters:

name - The extended property name.

value - The extended property value.

groupID - The ID of the group to set the extended property on.

Throws:

GroupNotFoundException

deleteProperty

void deleteProperty(java.lang.String name,
                    long groupID)
                    throws GroupNotFoundException

Deletes an extended property from the specfied group.

Parameters:

name - The name of the extended property to delete.

groupID - The id of the group to delete an extended property from.

Throws:

GroupNotFoundException

addMemberToGroup

void addMemberToGroup(long userID,
                      long groupID)
                      throws UserNotFoundException,
                             GroupNotFoundException

Add the user with the specified userID to the group with the specified groupID.

Parameters:

userID - The ID of the user to add to a group.

groupID - The ID of the group to add a user too.

Throws:

UserNotFoundException

GroupNotFoundException

addAdministratorToGroup

void addAdministratorToGroup(long userID,
                             long groupID)
                             throws UserNotFoundException,
                                    GroupNotFoundException

Make the user with the specified userID an administrator of the group with the specified groupID.

Parameters:

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.

Throws:

UserNotFoundException

GroupNotFoundException

removeMemberFromGroup

void removeMemberFromGroup(long userID,
                           long groupID)
                           throws UserNotFoundException,
                                  GroupNotFoundException

Remove the user with the specified id from the group with the specified id.

Parameters:

userID - The ID of the User to remove from a group.

groupID - The ID of the group to remove a user from.

Throws:

UserNotFoundException

GroupNotFoundException

removeAdministratorFromGroup

void removeAdministratorFromGroup(long userID,
                                  long groupID)
                                  throws UserNotFoundException,
                                         GroupNotFoundException

Remove the user with the specified ID as an administrator from the group with the specified ID.

Parameters:

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.

Throws:

UserNotFoundException

GroupNotFoundException