com.suncode.pwfl.administration.user

Interface UserFinder

All Superinterfaces:

BaseFinder<User,Long>

public interface UserFinder
extends BaseFinder<User,Long>

Umożliwia wyszukiwanie użytkowników

Author:

Paweł Rosolak 20 gru 2013

Method Summary

Methods

Modifier and Type	Method and Description
List<User>	findByCriteria(org.hibernate.criterion.DetachedCriteria dc, Integer start, Integer limit, boolean onlyActive) Funkcja umożliwia wyszukanie użytkowników bez zawężenia listy wyników do użytkowników aktywnych
CountedResult<User>	findByFilters(List<HibernateFilter> filters, UserSorter sorter, int start, int limit) Pobiera użytkowników na podstawie zdefiniowanych filtrów.
List<User>	findByGroup(String groupName) Pobiera użytkowników należących do podanej grupy
List<User>	findByGroups(List<String> groups) Pobiera listę użytkowników z podanych grup
List<User>	findByOU(String ouSymbol) Pobiera użytkowników z podanej jednostki
List<User>	findByOUs(List<String> ouSymbols) Pobiera użytkowników z podanych jednostek
List<User>	findByRoleId(Long roleId) Pobiera użytkowników posiadających stanowisko przypisane do podanej roli
List<User>	findByRoles(List<RoleFilter> filters) Wyszukuje użytkowników po zdefiniowanych rolach
User	findByUserName(String userName, boolean onlyActive, String... joins) Pobiera użytkownika po loginie.
User	findByUserName(String userName, String... joins) Pobiera użytkownika po loginie.
List<String>	findUserNamesByGroups(List<String> groups) Pobiera listę loginów użytkowników z podanych grup

Methods inherited from interface com.suncode.pwfl.support.BaseFinder

count, countAll, findByCriteria, findByCriteria, findByProperty, findOne, findOneByProperty, get, get, getAll, getAll, getCountedResult, getCountedResult

Method Detail

findByUserName

User findByUserName(String userName,
                  String... joins)

Pobiera użytkownika po loginie.

Parameters:

userName - Login użytkownika

joins - Określa, które elementy mamy dołączyć do obiektu User.

Returns:

Obiekt użytkownika

findByUserName

User findByUserName(String userName,
                  boolean onlyActive,
                  String... joins)

Pobiera użytkownika po loginie.

Parameters:

userName - Login użytkownika

onlyActive - Określa, czy brać pod uwagę użytkwoników nieaktywnych. Wartość false pozwoli uwzględnić użytkowników nieaktywnych.

joins - Określa, które elementy mamy dołączyć do obiektu User.

Returns:

Obiekt użytkownika

findByRoleId

List<User> findByRoleId(Long roleId)

Pobiera użytkowników posiadających stanowisko przypisane do podanej roli

Parameters:

roleId - Id roli(z bazy danych)

Returns:

Lista użytkowników

findByRoles

List<User> findByRoles(List<RoleFilter> filters)

Wyszukuje użytkowników po zdefiniowanych rolach

Parameters:

filters - Filtry ról

Returns:

Lista użytkowników

findByOUs

List<User> findByOUs(List<String> ouSymbols)

Pobiera użytkowników z podanych jednostek

Parameters:

ouSymbols - Lista symboli jednostki organizacyjnej

Returns:

Zwraca użytkowników z podanych jednostek

findByOU

List<User> findByOU(String ouSymbol)

Pobiera użytkowników z podanej jednostki

Parameters:

ouSymbol - Symbol jendostki

Returns:

Zwraca użytkowników z podanej jednostki

findByCriteria

List<User> findByCriteria(org.hibernate.criterion.DetachedCriteria dc,
                        Integer start,
                        Integer limit,
                        boolean onlyActive)

Funkcja umożliwia wyszukanie użytkowników bez zawężenia listy wyników do użytkowników aktywnych

Parameters:

dc - Definicja zapytania

start - Przesunięcie w zbiorze wyników

limit - Maksymalna ilość wyników

onlyActive - Określa, czy brać pod uwagę użytkwoników nieaktywnych. Wartość false pozwoli uwzględnić użytkowników nieaktywnych.

Returns:

Lista użytowników

findByGroup

List<User> findByGroup(String groupName)
                       throws GroupNotFoundException

Pobiera użytkowników należących do podanej grupy

Parameters:

groupName - Nazwa grupy dla której chcemy pobrać użytkowników

Returns:

Zbiór użytkowników

Throws:

GroupNotFoundException - Jeżeli nie znaleziono grupy o podanej nazwie

findByGroups

List<User> findByGroups(List<String> groups)

Pobiera listę użytkowników z podanych grup

Parameters:

groups - Lista nazw grup

Returns:

Lista loginów użytkowników

findUserNamesByGroups

List<String> findUserNamesByGroups(List<String> groups)

Pobiera listę loginów użytkowników z podanych grup

Parameters:

groups - Lista nazw grup

Returns:

Lista loginów użytkowników

findByFilters

CountedResult<User> findByFilters(List<HibernateFilter> filters,
                                UserSorter sorter,
                                int start,
                                int limit)

Pobiera użytkowników na podstawie zdefiniowanych filtrów.

Parameters:

filters - Lista zdefiniowanych filtrów wyszukiwania. Należy budować filtry z obiektów

sorter - Zdefiniowany rodzaj sortowania.

start - Przesunięcie w zbiorze wyników.

limit - Maksymalna ilość wyników.

Returns:

Obiekt zawierający całkowitą liczbę wyników oraz wyszukanych użytkowników.