cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IGroupService.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2007 EDIT
   4 * European Distributed Institute of Taxonomy
   5 * http://www.e-taxonomy.eu
   6 *
   7 * The contents of this file are subject to the Mozilla Public License Version 1.1
   8 * See LICENSE.TXT at the top of this package for the full license terms.
   9 */
  10
  11 package eu.etaxonomy.cdm.api.service;
  12
  13 import java.util.List;
  14 import java.util.UUID;
  15
  16 import org.hibernate.criterion.Criterion;
  17 import org.springframework.security.provisioning.GroupManager;
  18
  19 import eu.etaxonomy.cdm.model.common.Group;
  20 import eu.etaxonomy.cdm.persistence.dao.initializer.IBeanInitializer;
  21 import eu.etaxonomy.cdm.persistence.query.MatchMode;
  22 import eu.etaxonomy.cdm.persistence.query.OrderHint;
  23
  24 /**
  25  * @author n.hoffmann
  26  * @created Mar 9, 2011
  27  * @version 1.0
  28  */
  29 public interface IGroupService extends IService<Group>, GroupManager{
  30
  31
  32     /**
  33      * Return a List of groups matching the given query string, optionally filtered by class, optionally with a particular MatchMode
  34      *
  35      * @param queryString the query string to filter by
  36      * @param matchmode use a particular type of matching (can be null - defaults to exact matching)
  37      * @param criteria additional criteria to filter by
  38      * @param pageSize The maximum number of objects returned (can be null for all objects)
  39      * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
  40      * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
  41      * @param orderHints
  42      *            Supports path like <code>orderHints.propertyNames</code> which
  43      *            include *-to-one properties like createdBy.username or
  44      *            authorTeam.persistentTitleCache
  45      * @return a list of instances of type Group matching the queryString
  46      *
  47      * @see {@link IIdentifiableEntityService#listByTitle(Class, String, MatchMode, List, Integer, Integer, List, List)}
  48      */
  49     public List<Group> listByName(String queryString, MatchMode matchmode, List<Criterion> criteria, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
  50
  51     public UUID saveGroup(Group group);
  52
  53
  54
  55 }