2 * Copyright (C) 2009 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.
10 package eu
.etaxonomy
.cdm
.api
.service
;
12 import java
.util
.List
;
13 import java
.util
.UUID
;
15 import org
.hibernate
.criterion
.Criterion
;
16 import org
.springframework
.dao
.DataAccessException
;
17 import org
.springframework
.security
.core
.GrantedAuthority
;
18 import org
.springframework
.security
.core
.userdetails
.UsernameNotFoundException
;
19 import org
.springframework
.security
.provisioning
.GroupManager
;
20 import org
.springframework
.security
.provisioning
.UserDetailsManager
;
22 import eu
.etaxonomy
.cdm
.model
.common
.Group
;
23 import eu
.etaxonomy
.cdm
.model
.common
.User
;
24 import eu
.etaxonomy
.cdm
.persistence
.dao
.initializer
.IBeanInitializer
;
25 import eu
.etaxonomy
.cdm
.persistence
.query
.MatchMode
;
26 import eu
.etaxonomy
.cdm
.persistence
.query
.OrderHint
;
28 public interface IUserService
extends IService
<User
>, UserDetailsManager
, GroupManager
{
30 public void changePasswordForUser(String username
, String password
) throws UsernameNotFoundException
, DataAccessException
;
32 public UUID
saveGrantedAuthority(GrantedAuthority grantedAuthority
);
37 * Return a List of users matching the given query string, optionally filtered by class, optionally with a particular MatchMode
39 * @param queryString the query string to filter by
40 * @param matchmode use a particular type of matching (can be null - defaults to exact matching)
41 * @param criteria additional criteria to filter by
42 * @param pageSize The maximum number of objects returned (can be null for all objects)
43 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
44 * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
46 * Supports path like <code>orderHints.propertyNames</code> which
47 * include *-to-one properties like createdBy.username or
48 * authorTeam.persistentTitleCache
49 * @return a list of instances of type User matching the queryString
51 * @see {@link IIdentifiableEntityService#listByTitle(Class, String, MatchMode, List, Integer, Integer, List, List)}
54 public List
<User
> listByUsername(String queryString
, MatchMode matchmode
, List
<Criterion
> criteria
, Integer pageSize
, Integer pageNumber
, List
<OrderHint
> orderHints
, List
<String
> propertyPaths
);