org.dspace.app.xmlui.aspect.administrative
Class FlowGroupUtils

java.lang.Object
  org.dspace.app.xmlui.aspect.administrative.FlowGroupUtils

public class FlowGroupUtils
extends java.lang.Object

Utility methods to processes actions on Groups. These methods are used exclusivly from the administrative flow scripts.

Author:

scott phillips

Nested Class Summary

static class

FlowGroupUtils.Role

Constructor Summary

FlowGroupUtils()

Method Summary

static java.lang.String[]	addMember(java.lang.String[] list, java.lang.String id) Add the given id to the list and return a new list.
static int	getCollectionId(java.lang.String groupName) Extracts the collection id that may be immbedded in the given group name.
static FlowGroupUtils.Role	getCollectionRole(java.lang.String groupName)
static int	getCommunityId(java.lang.String groupName) Extracts the community id that may be embedded in the given group name.
static FlowGroupUtils.Role	getCommunityRole(java.lang.String groupName)
static java.lang.String[]	getEPeopleMembers(Context context, int groupID) Return the list of current epeople ID's that are a member of this group.
static java.lang.String[]	getGroupMembers(Context context, int groupID) Return the list of current group id's that are a member of this group.
static java.lang.String	getName(Context context, int groupID) Return the current name for the given group ID.
static FlowResult	processDeleteGroups(Context context, java.lang.String[] groupIDs) Remove the specified groups.
static FlowResult	processSaveGroup(Context context, int groupID, java.lang.String newName, java.lang.String[] newEPeopleIDsArray, java.lang.String[] newGroupIDsArray) Save the group.
static java.lang.String[]	removeMember(java.lang.String[] list, java.lang.String id) Remove all instances of the given id from the member list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlowGroupUtils

public FlowGroupUtils()

Method Detail

getName

public static java.lang.String getName(Context context,
                                       int groupID)
                                throws java.sql.SQLException

Return the current name for the given group ID.

Parameters:

context - The current DSpace context.

groupID - The group id.

Returns:

The group's name.

Throws:

java.sql.SQLException

getEPeopleMembers

public static java.lang.String[] getEPeopleMembers(Context context,
                                                   int groupID)
                                            throws java.sql.SQLException

Return the list of current epeople ID's that are a member of this group.

Parameters:

context - The current DSpace context

groupID - The group's id.

Returns:

An array of ids.

Throws:

java.sql.SQLException

getGroupMembers

public static java.lang.String[] getGroupMembers(Context context,
                                                 int groupID)
                                          throws java.sql.SQLException

Return the list of current group id's that are a member of this group.

Parameters:

context - The current DSpace context

groupID - The group's id.

Returns:

An array of ids.

Throws:

java.sql.SQLException

addMember

public static java.lang.String[] addMember(java.lang.String[] list,
                                           java.lang.String id)

Add the given id to the list and return a new list.

Parameters:

list - The current array

id - The new element

Returns:

A new combined array.

removeMember

public static java.lang.String[] removeMember(java.lang.String[] list,
                                              java.lang.String id)

Remove all instances of the given id from the member list.

Parameters:

list - The current array

id - The id to remove

Returns:

A new combined array.

processSaveGroup

public static FlowResult processSaveGroup(Context context,
                                          int groupID,
                                          java.lang.String newName,
                                          java.lang.String[] newEPeopleIDsArray,
                                          java.lang.String[] newGroupIDsArray)
                                   throws java.sql.SQLException,
                                          AuthorizeException,
                                          UIException

Save the group. If the name has been changed then it will be updated, if any members have been added or removed then they are updated. If the groupID is -1 then a new group is created.

Parameters:

context - The current dspace context

groupID - The group id, or -1 for a new group.

newName - The group's new name.

newEPeopleIDsArray - All epeople members

newGroupIDsArray - All group members.

Returns:

A result

Throws:

java.sql.SQLException

AuthorizeException

UIException

processDeleteGroups

public static FlowResult processDeleteGroups(Context context,
                                             java.lang.String[] groupIDs)
                                      throws java.sql.SQLException,
                                             AuthorizeException,
                                             java.io.IOException

Remove the specified groups. It is assumed that the user has allready confirm this selection.

Parameters:

context - The current DSpace context

groupIDs - A list of groups to be removed.

Returns:

A results object.

Throws:

java.sql.SQLException

AuthorizeException

java.io.IOException

getCollectionId

public static int getCollectionId(java.lang.String groupName)

Extracts the collection id that may be immbedded in the given group name.

Parameters:

groupName - - the name of a group (ie group.getName())

Returns:

the integer collection id or -1 if the group is not that of a collection

getCollectionRole

public static FlowGroupUtils.Role getCollectionRole(java.lang.String groupName)

getCommunityId

public static int getCommunityId(java.lang.String groupName)

Extracts the community id that may be embedded in the given group name.

Parameters:

groupName - - the name of a group (ie group.getName())

Returns:

the integer community id or -1 if the group is not that of a community

getCommunityRole

public static FlowGroupUtils.Role getCommunityRole(java.lang.String groupName)