com.suncode.pwfl.administration.substitution

Interface SubstitutionFinder

All Superinterfaces:

BaseFinder<Substitution,Long>

public interface SubstitutionFinder
extends BaseFinder<Substitution,Long>

Umożliwia złożone wyszukiwanie zastępstw.

Author:

Rafał Nowacki 26-08-2014

Method Summary

Modifier and Type	Method and Description
CountedResult<Substitution>	findAll(org.joda.time.LocalDate fromDate, Pagination pagination) Metoda pobiera wszystkie zastępstwa w systemie, które są aktywne lub zakończone nie wcześniej niż podana data.
CountedResult<Substitution>	findAllForUser(String userName, org.joda.time.LocalDate fromDate, Pagination pagination) Metoda pobiera wszystkie zastępstwa w systemie dla użytkownika, które są aktywne lub zakończone nie wcześniej niż podana data.
CountedResult<Substitution>	findByFilters(HibernateFilter filters, Pagination pagination) Pobiera zastępstwa na podstawie zdefiniowanych filtrów.
List<Substitution>	findOverlappedSubstitutions(Substitution substitution) Metoda wyszukuje zastępstwa, na które nachodzi zdefiniowane zastępstwo.
CountedResult<Substitution>	findSubstitutionsForUserOus(String userName, org.joda.time.LocalDate fromDate, boolean includeSubOus, Pagination pagination) Metoda wyszukuje zdefiniowane zastępstwa dla wszystkich użytkowników należących do tej samej jednostki organizacyjnej, co podany użytkownik.

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

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

Method Detail

findAll

CountedResult<Substitution> findAll(org.joda.time.LocalDate fromDate,
                                    Pagination pagination)

Metoda pobiera wszystkie zastępstwa w systemie, które są aktywne lub zakończone nie wcześniej niż podana data. Aktywne zastępstwa to takie, które obowiązują w momencie wyszukiwania. Uwzględniane są włącznie data rozpoczęcia i zakończenia zastępstwa.

Parameters:

fromDate - Data, począwszy od której mają być wyszukiwane zastępstwa. Zastępstwa z datą zakończenia wcześniejszą niż podana data nie będą wyszukiwane. Parametr może mieć wartość null, wtedy nie jest uwzględniane to ograniczenie.

pagination - Parametr definiujący rodzaj sortowania, przesunięcie w zbiorze wyników oraz maksymalną ilość wyników. Do ustawienia pola, według którego ma być sortowanie można posłużyć się klasą pomocniczą SubstitutionProperty.

Returns:

Obiekt zawierający całkowitą liczbę wyników oraz wyszukane zastępstwa.

findAllForUser

CountedResult<Substitution> findAllForUser(String userName,
                                           org.joda.time.LocalDate fromDate,
                                           Pagination pagination)

Metoda pobiera wszystkie zastępstwa w systemie dla użytkownika, które są aktywne lub zakończone nie wcześniej niż podana data. Pobierane są zastępstwa, w których użytkownik jest zastępcą lub zastępowanym. Aktywne zastępstwa to takie, które obowiązują w momencie wyszukiwania. Uwzględniane są włącznie data rozpoczęcia i zakończenia zastępstwa.

Parameters:

userName - Login użytkownika, którego zastępstwa mają zostać pobrane.

fromDate - Data, począwszy od której mają być wyszukiwane zastępstwa. Zastępstwa z datą zakończenia wcześniejszą niż podana data nie będą wyszukiwane. Parametr może mieć wartość null, wtedy nie jest uwzględniane to ograniczenie.

pagination - Parametr definiujący rodzaj sortowania, przesunięcie w zbiorze wyników oraz maksymalną ilość wyników. Do ustawienia pola, według którego ma być sortowanie można posłużyć się klasą pomocniczą SubstitutionProperty.

Returns:

Obiekt zawierający całkowitą liczbę wyników oraz wyszukane zastępstwa.

findOverlappedSubstitutions

List<Substitution> findOverlappedSubstitutions(Substitution substitution)

Metoda wyszukuje zastępstwa, na które nachodzi zdefiniowane zastępstwo.

Parameters:

substitution - Obiekt zdefiniowanego zastępstwa.

Returns:

Lista zastępstw.

findSubstitutionsForUserOus

CountedResult<Substitution> findSubstitutionsForUserOus(String userName,
                                                        org.joda.time.LocalDate fromDate,
                                                        boolean includeSubOus,
                                                        Pagination pagination)

Metoda wyszukuje zdefiniowane zastępstwa dla wszystkich użytkowników należących do tej samej jednostki organizacyjnej, co podany użytkownik.

Parameters:

userName - Login użytkownika.

fromDate - Data, począwszy od której mają być wyszukiwane zastępstwa. Zastępstwa z datą zakończenia wcześniejszą niż podana data nie będą wyszukiwane. Parametr może mieć wartość null, wtedy nie jest uwzględniane to ograniczenie.

includeSubOus - Parametr określa, czy mają być wyszukane zastępstwa dla użytkowników, którzy należą do jednostek podrzędnych.

pagination - Parametr definiujący rodzaj sortowania, przesunięcie w zbiorze wyników oraz maksymalną ilość wyników. Do ustawienia pola, według którego ma być sortowanie można posłużyć się klasą pomocniczą SubstitutionProperty.

Returns:

Obiekt zawierający całkowitą liczbę wyników oraz wyszukane zastępstwa.

findByFilters

CountedResult<Substitution> findByFilters(HibernateFilter filters,
                                          Pagination pagination)

Pobiera zastępstwa na podstawie zdefiniowanych filtrów.

Parameters:

filters - Zdefiniowane filtry wyszukiwania. Należy budować filtry z obiektów SimpleHibernateFilter i GroupHibernateFilter. Do ustawiania pól można posłużyć się klasą pomocniczą SubstitutionProperty.

pagination - Parametr definiujący rodzaj sortowania, przesunięcie w zbiorze wyników oraz maksymalną ilość wyników. Do ustawienia pola, według którego ma być sortowanie można posłużyć się klasą pomocniczą SubstitutionProperty.

Returns:

Obiekt zawierający całkowitą liczbę wyników oraz wyszukane zastępstwa.