2 * Copyright (C) 2007 EDIT
3 * European Distributed Institute of Taxonomy
4 * http://www.e-taxonomy.eu
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * See LICENSE.TXT at the top of this package for the full license terms.
9 package eu
.etaxonomy
.cdm
.api
.service
;
11 import java
.util
.List
;
12 import java
.util
.UUID
;
14 import org
.hibernate
.criterion
.Criterion
;
15 import org
.springframework
.security
.provisioning
.GroupManager
;
17 import eu
.etaxonomy
.cdm
.model
.permission
.Group
;
18 import eu
.etaxonomy
.cdm
.persistence
.dao
.initializer
.IBeanInitializer
;
19 import eu
.etaxonomy
.cdm
.persistence
.query
.MatchMode
;
20 import eu
.etaxonomy
.cdm
.persistence
.query
.OrderHint
;
23 * Service for {@link Group user groups}
28 public interface IGroupService
extends IService
<Group
>, GroupManager
{
32 * Return a List of groups matching the given query string, optionally filtered by class, optionally with a particular MatchMode
34 * @param queryString the query string to filter by
35 * @param matchmode use a particular type of matching (can be null - defaults to exact matching)
36 * @param criteria additional criteria to filter by
37 * @param pageSize The maximum number of objects returned (can be null for all objects)
38 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
39 * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
41 * Supports path like <code>orderHints.propertyNames</code> which
42 * include *-to-one properties like createdBy.username or
43 * authorTeam.persistentTitleCache
44 * @return a list of instances of type Group matching the queryString
46 * @see {@link IIdentifiableEntityService#listByTitle(Class, String, MatchMode, List, Integer, Integer, List, List)}
48 public List
<Group
> listByName(String queryString
, MatchMode matchmode
, List
<Criterion
> criteria
, Integer pageSize
, Integer pageNumber
, List
<OrderHint
> orderHints
, List
<String
> propertyPaths
);
50 public UUID
saveGroup(Group group
);
53 * Checks whether or not a group with the given name exists.
56 public boolean groupExists(String groupName
);
59 * Returns the group with the given group name or <code>null</code> if such a user
62 public Group
findGroup(String groupName
);