org.dspace.eperson.dao.GroupDAO Maven / Gradle / Ivy
Show all versions of dspace-api Show documentation
/**
* The contents of this file are subject to the license and copyright
* detailed in the LICENSE and NOTICE files at the root of the source
* tree and available online at
*
* http://www.dspace.org/license/
*/
package org.dspace.eperson.dao;
import java.sql.SQLException;
import java.util.List;
import java.util.UUID;
import org.apache.commons.lang3.tuple.Pair;
import org.dspace.content.MetadataField;
import org.dspace.content.dao.DSpaceObjectDAO;
import org.dspace.content.dao.DSpaceObjectLegacySupportDAO;
import org.dspace.core.Context;
import org.dspace.eperson.EPerson;
import org.dspace.eperson.Group;
/**
* Database Access Object interface class for the Group object.
* The implementation of this class is responsible for all database calls for the Group object and is autowired by
* spring
* This class should only be accessed from a single service and should never be exposed outside of the API
*
* @author kevinvandevelde at atmire.com
*/
public interface GroupDAO extends DSpaceObjectDAO, DSpaceObjectLegacySupportDAO {
/**
* Look up groups based on their value for a certain metadata field (NOTE: name is not stored as metadata)
*
* @param context The DSpace context
* @param searchValue The value to match
* @param metadataField The metadata field to search in
* @return The groups that have a matching value for specified metadata field
* @throws SQLException if database error
*/
List findByMetadataField(Context context, String searchValue, MetadataField metadataField)
throws SQLException;
/**
* Find all groups ordered by the specified metadata fields ascending
*
* @param context The DSpace context
* @param metadataSortFields The metadata fields to sort on
* @param pageSize how many results return
* @param offset the position of the first result to return
* @return A list of all groups, ordered by metadata fields
* @throws SQLException if database error
*/
List findAll(Context context, List metadataSortFields, int pageSize, int offset)
throws SQLException;
/**
* Find all groups ordered by name ascending
*
* @param context The DSpace context
* @param pageSize how many results return
* @param offset the position of the first result to return
* @return A list of all groups, ordered by name
* @throws SQLException if database error
*/
List findAll(Context context, int pageSize, int offset) throws SQLException;
/**
* Find all groups that the given ePerson belongs to
*
* @param context The DSpace context
* @param ePerson The EPerson to match
* @return A list of all groups to which the given EPerson belongs
* @throws SQLException if database error
*/
List findByEPerson(Context context, EPerson ePerson) throws SQLException;
/**
* Get a list of all direct parent - child group relations in the database
*
* @param context The DSpace context
* @param flushQueries Flush all pending queries
* @return A list of pairs indicating parent - child
* @throws SQLException if database error
*/
List> getGroup2GroupResults(Context context, boolean flushQueries) throws SQLException;
/**
* Return all empty groups
*
* @param context The DSpace context
* @return All empty groups
* @throws SQLException if database error
*/
List getEmptyGroups(Context context) throws SQLException;
/**
* Count the number of groups in DSpace
*
* @param context The DSpace context
* @return The number of groups
* @throws SQLException if database error
*/
int countRows(Context context) throws SQLException;
/**
* Find a group by its name (exact match)
*
* @param context The DSpace context
* @param name The name of the group to look for
* @return The group with the specified name
* @throws SQLException if database error
*/
Group findByName(Context context, String name) throws SQLException;
/**
* Find a group by its name (fuzzy match)
*
* @param context The DSpace context
* @param groupName Part of the group's name to search for
* @param offset Offset to use for pagination (-1 to disable)
* @param limit The maximum number of results to return (-1 to disable)
* @return Groups matching the query
* @throws SQLException if database error
*/
List findByNameLike(Context context, String groupName, int offset, int limit) throws SQLException;
/**
* Count the number of groups that have a name that contains the given string
*
* @param context The DSpace context
* @param groupName Part of the group's name to search for
* @return The number of matching groups
* @throws SQLException if database error
*/
int countByNameLike(Context context, String groupName) throws SQLException;
/**
* Search all groups via their name (fuzzy match), limited to those groups which are NOT a member of the given
* parent group. This may be used to search across groups which are valid to add to the given parent group.
*
* NOTE: The parent group itself is also excluded from the search.
*
* @param context The DSpace context
* @param groupName Group name to fuzzy match against.
* @param excludeParent Parent Group to exclude results from. Groups under this parent will never be returned.
* @param offset Offset to use for pagination (-1 to disable)
* @param limit The maximum number of results to return (-1 to disable)
* @return Groups matching the query (which are not members of the given parent)
* @throws SQLException if database error
*/
List findByNameLikeAndNotMember(Context context, String groupName, Group excludeParent,
int offset, int limit) throws SQLException;
/**
* Count number of groups that match a given name (fuzzy match), limited to those groups which are NOT a member of
* the given parent group. This may be used (with findByNameLikeAndNotMember()) to search across groups which are
* valid to add to the given parent group.
*
* NOTE: The parent group itself is also excluded from the count.
*
* @param context The DSpace context
* @param groupName Group name to fuzzy match against.
* @param excludeParent Parent Group to exclude results from. Groups under this parent will never be returned.
* @return Groups matching the query (which are not members of the given parent)
* @throws SQLException if database error
*/
int countByNameLikeAndNotMember(Context context, String groupName, Group excludeParent) throws SQLException;
/**
* Find a group by its name and the membership of the given EPerson
*
* @param context The DSpace context
* @param id The id of the group to look for
* @param ePerson The EPerson which has to be a member
* @return The group with the specified name
* @throws SQLException if database error
*/
Group findByIdAndMembership(Context context, UUID id, EPerson ePerson) throws SQLException;
/**
* Find all groups which are members of a given parent group.
* This provides the same behavior as group.getMemberGroups(), but in a paginated fashion.
*
* @param context The DSpace context
* @param parent Parent Group to search within
* @param pageSize how many results return
* @param offset the position of the first result to return
* @return Groups matching the query
* @throws SQLException if database error
*/
List findByParent(Context context, Group parent, int pageSize, int offset) throws SQLException;
/**
* Returns the number of groups which are members of a given parent group.
* This provides the same behavior as group.getMemberGroups().size(), but with better performance for large groups.
* This method may be used with findByParent() to perform pagination.
*
* @param context The DSpace context
* @param parent Parent Group to search within
* @return Number of Groups matching the query
* @throws SQLException if database error
*/
int countByParent(Context context, Group parent) throws SQLException;
}