Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.webservices.server
Class GroupServiceImpl

java.lang.Object
  extended by com.jivesoftware.forum.webservices.server.GroupServiceImpl
All Implemented Interfaces:
GroupService

public class GroupServiceImpl
extends java.lang.Object
implements GroupService


Constructor Summary
GroupServiceImpl()
           
 
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 id)
          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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupServiceImpl

public GroupServiceImpl()
Method Detail

getGroup

public Group getGroup(long id)
               throws GroupNotFoundException
Description copied from interface: GroupService
Returns a Group by its ID.

Specified by:
getGroup in interface GroupService
Parameters:
id - The ID of the group.
Returns:
The group that matches the ID specified.
Throws:
GroupNotFoundException

getGroupByName

public Group getGroupByName(java.lang.String name)
                     throws GroupNotFoundException
Description copied from interface: GroupService
Returns a Group by its name.

Specified by:
getGroupByName in interface GroupService
Parameters:
name - The name of the group.
Returns:
The group with the matching name.
Throws:
GroupNotFoundException

getGroupMembers

public User[] getGroupMembers(long groupID)
                       throws GroupNotFoundException
Description copied from interface: GroupService
Returns an array of all userIDs for all the members of a particular group.

Specified by:
getGroupMembers in interface GroupService
Parameters:
groupID - The ID of the group to acquire members for.
Returns:
A array of user IDs.
Throws:
GroupNotFoundException

getGroupCount

public int getGroupCount()
Description copied from interface: GroupService
Returns a count of all groups in the system.

Specified by:
getGroupCount in interface GroupService
Returns:
A count of all groups in the system.

getGroups

public Group[] getGroups()
Description copied from interface: GroupService
Returns an array of all the group IDs for all the groups in the system.

Specified by:
getGroups in interface GroupService
Returns:
An array of all the group IDs for all the groups in the system.

getUserGroups

public Group[] getUserGroups(long userID)
                      throws UserNotFoundException
Description copied from interface: GroupService
Returns an array of all the group IDs that a user belongs too.

Specified by:
getUserGroups in interface GroupService
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

public User[] getGroupAdmins(long groupID)
                      throws GroupNotFoundException
Description copied from interface: GroupService
Returns an array of all the user IDs that administer this group.

Specified by:
getGroupAdmins in interface GroupService
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

public int getAdministratorCount(long groupID)
                          throws GroupNotFoundException
Description copied from interface: GroupService
Returns the count of how many administrators there are for the group with the specified ID.

Specified by:
getAdministratorCount in interface GroupService
Parameters:
groupID - The ID of the group to acquire the administrator count for.
Returns:
The number of administrators in the group.
Throws:
GroupNotFoundException

createGroup

public Group createGroup(java.lang.String name,
                         java.lang.String description)
                  throws GroupAlreadyExistsException
Description copied from interface: GroupService
Creates a new group.

Specified by:
createGroup in interface GroupService
Parameters:
name - The name of the group.
description - A short description of this group.
Returns:
The newly created group.
Throws:
GroupAlreadyExistsException

deleteGroup

public void deleteGroup(long groupID)
                 throws GroupNotFoundException
Description copied from interface: GroupService
Delete the group with the specified id.

Specified by:
deleteGroup in interface GroupService
Parameters:
groupID - The id of the group to delete.
Throws:
GroupNotFoundException

updateGroup

public void updateGroup(Group group)
                 throws GroupNotFoundException
Description copied from interface: GroupService
Update the following group in the system.

Specified by:
updateGroup in interface GroupService
Parameters:
group - The group to update.
Throws:
GroupNotFoundException

getProperties

public Property[] getProperties(long groupID)
                         throws GroupNotFoundException
Description copied from interface: GroupService
Returns an array of all the extended properties for a group.

Specified by:
getProperties in interface GroupService
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

public void setProperty(java.lang.String name,
                        java.lang.String value,
                        long groupID)
                 throws GroupNotFoundException
Description copied from interface: GroupService
Set a new extended property on the specified group.

Specified by:
setProperty in interface GroupService
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

public void deleteProperty(java.lang.String name,
                           long groupID)
                    throws GroupNotFoundException
Description copied from interface: GroupService
Deletes an extended property from the specfied group.

Specified by:
deleteProperty in interface GroupService
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

public void addMemberToGroup(long userID,
                             long groupID)
                      throws UserNotFoundException,
                             GroupNotFoundException
Description copied from interface: GroupService
Add the user with the specified userID to the group with the specified groupID.

Specified by:
addMemberToGroup in interface GroupService
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

public void addAdministratorToGroup(long userID,
                                    long groupID)
                             throws UserNotFoundException,
                                    GroupNotFoundException
Description copied from interface: GroupService
Make the user with the specified userID an administrator of the group with the specified groupID.

Specified by:
addAdministratorToGroup in interface GroupService
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

public void removeMemberFromGroup(long userID,
                                  long groupID)
                           throws UserNotFoundException,
                                  GroupNotFoundException
Description copied from interface: GroupService
Remove the user with the specified id from the group with the specified id.

Specified by:
removeMemberFromGroup in interface GroupService
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

public void removeAdministratorFromGroup(long userID,
                                         long groupID)
                                  throws UserNotFoundException,
                                         GroupNotFoundException
Description copied from interface: GroupService
Remove the user with the specified ID as an administrator from the group with the specified ID.

Specified by:
removeAdministratorFromGroup in interface GroupService
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

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.