com.suncode.pwfl.archive

Interface DocumentFinder

public interface DocumentFinder

Umożliwia wyszukiwanie dokumentów.

Author:

Paweł Rosolak 20 gru 2013

Method Summary

Modifier and Type	Method and Description
WfDocument	findByFileId(Long fileId, Long documentClassId) Pobiera dokument po id pliku
CountedResult<WfDocument>	findByIndexes(Long documentClassId, List<IndexFilter> indexFilters, List<Sorter> sorters, Integer start, Integer limit, String... joins) Wyszukuje dokumenty o podanych parametrach.
CountedResult<WfDocument>	findByIndexes(Long documentClassId, Map<Long,Object> indexes, List<Sorter> sorters, Integer start, Integer limit, String... joins) Wyszukuje dokumenty o podanych indeksach
CountedResult<WfDocument>	findByIndexesForUser(String username, Long documentClassId, List<IndexFilter> indexFilters, List<Sorter> sorters, Integer start, Integer limit, String... joins) Wyszukuje dokumenty o podanych parametrach.
CountedResult<WfDocument>	findByIndexesForUser(String username, Long documentClassId, Map<Long,Object> indexes, List<Sorter> sorters, Integer start, Integer limit, String... joins) Wyszukuje dokumenty o podanych parametrach.
List<WfDocument>	findExpiredDocuments() Wyszukuje dokumenty, których termin ważności się zakończył
WfDocument	findOneByIndexes(Long documentClassId, List<IndexFilter> indexFilters) Wyszukuje dokument o podanych parametrach.
WfDocument	getDocument(Long documentId, Long documentClassId) Pobiera dokument po id
List<WfDocument>	getDocumentsFromActivity(String processId, String activityId, String... joins) Pobiera dokumenty dla podanego zadania
List<WfDocument>	getDocumentsFromOpenedActivities(String processId, String... joins) Pobiera dokumenty z podanego procesu podłączone do wszystkich otwartych zadań
List<WfDocument>	getDocumentsFromProcess(String processId, String... joins) Pobiera dokumenty z procesu.
List<WfDocument>	getDocumentsFromProcessAndClass(String processId, String docClassName, String... joins) Pobiera dokumenty z procesu, należące do określonej klasy.

Method Detail

getDocument

WfDocument getDocument(Long documentId,
                       Long documentClassId)

Pobiera dokument po id

Parameters:

documentId - Id dokumentu ( z tabeli pm_idx000x )

documentClassId - Id klasy dokuemntów

Returns:

Definicja dokumentu

findByFileId

WfDocument findByFileId(Long fileId,
                        Long documentClassId)

Pobiera dokument po id pliku

Parameters:

fileId - Id pliku (z tabeli pm_files)

documentClassId - Id klasy dokumentów

Returns:

Definicja dokumentu

findOneByIndexes

WfDocument findOneByIndexes(Long documentClassId,
                            List<IndexFilter> indexFilters)

Wyszukuje dokument o podanych parametrach.

Parameters:

documentClassId - Id klasy dokumentów

indexFilters - Lista filtrów.

Returns:

Znaleziony dokument

findByIndexes

CountedResult<WfDocument> findByIndexes(Long documentClassId,
                                        List<IndexFilter> indexFilters,
                                        List<Sorter> sorters,
                                        Integer start,
                                        Integer limit,
                                        String... joins)

Wyszukuje dokumenty o podanych parametrach.

Parameters:

documentClassId - Id klasy dokumentów

indexFilters - Lista filtrów.

sorters - Sortowanie

start - Przesunięcie w zbiorze wyników

limit - Maksymalna ilość wyników

Returns:

Lista znalezionych dokumentów, wraz z całkowitą ilości elementów

findByIndexesForUser

CountedResult<WfDocument> findByIndexesForUser(String username,
                                               Long documentClassId,
                                               List<IndexFilter> indexFilters,
                                               List<Sorter> sorters,
                                               Integer start,
                                               Integer limit,
                                               String... joins)

Wyszukuje dokumenty o podanych parametrach.

Parameters:

documentClassId - Id klasy dokumentów

indexFilters - Lista filtrów.

sorters - Sortowanie

start - Przesunięcie w zbiorze wyników

limit - Maksymalna ilość wyników

username - Login użytkownika

Returns:

Lista znalezionych dokumentów, wraz z całkowitą ilości elementów

findByIndexes

CountedResult<WfDocument> findByIndexes(Long documentClassId,
                                        Map<Long,Object> indexes,
                                        List<Sorter> sorters,
                                        Integer start,
                                        Integer limit,
                                        String... joins)

Wyszukuje dokumenty o podanych indeksach

Parameters:

documentClassId - Id klasy dokumentów

indexes - Wartości indeksów - klucz to id indeksu

sorters - Sortowanie

start - Przesunięcie w zbiorze wyników

limit - Maksymalna ilość wyników

Returns:

Lista znalezionych dokumentów

findByIndexesForUser

CountedResult<WfDocument> findByIndexesForUser(String username,
                                               Long documentClassId,
                                               Map<Long,Object> indexes,
                                               List<Sorter> sorters,
                                               Integer start,
                                               Integer limit,
                                               String... joins)

Wyszukuje dokumenty o podanych parametrach.

Parameters:

documentClassId - Id klasy dokumentów

indexes - Wartości indeksów - klucz to id indeksu

sorters - Sortowanie

start - Przesunięcie w zbiorze wyników

limit - Maksymalna ilość wyników

username - Login użytkownika

Returns:

Lista znalezionych dokumentów, wraz z całkowitą ilości elementów

getDocumentsFromActivity

List<WfDocument> getDocumentsFromActivity(String processId,
                                          String activityId,
                                          String... joins)

Pobiera dokumenty dla podanego zadania

Parameters:

activityId - Id zadania

Returns:

getDocumentsFromProcess

List<WfDocument> getDocumentsFromProcess(String processId,
                                         String... joins)

Pobiera dokumenty z procesu. Dokumenty z procesu to dokumenty dołączone do ostatniego zadania procesu(czyli do zadania, które ostatnie zmieniło swój stan)

Parameters:

processId - Id procesu

Returns:

getDocumentsFromProcessAndClass

List<WfDocument> getDocumentsFromProcessAndClass(String processId,
                                                 String docClassName,
                                                 String... joins)

Pobiera dokumenty z procesu, należące do określonej klasy. Dokumenty z procesu to dokumenty dołączone do ostatniego zadania procesu(czyli do zadania, które ostatnie zmieniło swój stan)

Parameters:

processId - Id procesu

docClassName - nazwa klasy dokumentów

Returns:

getDocumentsFromOpenedActivities

List<WfDocument> getDocumentsFromOpenedActivities(String processId,
                                                  String... joins)

Pobiera dokumenty z podanego procesu podłączone do wszystkich otwartych zadań

Parameters:

processId - Id procesu

Returns:

findExpiredDocuments

List<WfDocument> findExpiredDocuments()

Wyszukuje dokumenty, których termin ważności się zakończył

Returns:

Lista przeterminowanych dokumentów