com.suncode.pwfl.archive

Interface DocumentClassService

All Superinterfaces:

BaseFinder<DocumentClass,Long>

public interface DocumentClassService
extends BaseFinder<DocumentClass,Long>

Umożliwia zarządzanie klasami dokumentów.

Author:

Paweł Rosolak 19-03-2013

Method Summary

Modifier and Type	Method and Description
void	addActionToDocumentClass(Long docClassId, DocumentClassAction action) Dodaje akcje do klasy dokumentów
void	addIndexToDocumentClass(Long docClassId, DocumentClassIndex index) Dodaje indeks do klasy dokumentów
void	createDocumentClass(DocumentClass dc) Zapisuje klasa dokumentów w bazie danych.
void	createDocumentClassAssociation(DocumentClassAssociation documentClassAssociation) Zapisuje powiązanie między klasami dokumentów w bazie danych.
void	deleteDocumentClass(Long documentClassId) Usuwa klasę dokumentów
void	deleteDocumentClass(String name) Usuwa klasę dokumentów
void	deleteDocumentClassAssociation(DocumentClassAssociation documentClassAssociation) Usuwa powiązanie między klasami dokumentów w bazie danych.
void	deleteDocumentClassAssociationById(Long associationId) Usuwa powiązanie między klasami dokumentów w bazie danych.
Map<Long,Object>	executePatterns(Map<Long,Object> indexes) Aktualizuje indeksy względem przypisanych wzorców.
List<WfDocument>	getAllAssociatedDocumentsForClass(Long documentClassId, Long documentId, String userName) Pobiera listę wszystkich dokumentów powiązanych dla dokumentu o Id przekazanym w parametrze documentId.
CountedResult<WfDocument>	getAssociatedDocumentsFromClass(Long documentClassId, Long documentId, Long childDocumentClassId, Integer start, Integer limit, String sort, String dir, String userName) Pobiera listę dokumentów powiązanych należących do klasy przekazanej w parametrze childDocumentClassId
DocumentClass	getDocumentClass(String name, String... joins) Pobiera obiekt klasy dokumentów
File	getDocumentClassDirectory(Long docClassId) Pobiera katalog klasy dokumentów (dla dynamicznie tworzonych nazw katalogów nazwa generowana jest na podstawie aktualnej daty)
List<DocumentClass>	getDocumentClassesForProcess(String processDefId) Pobiera klasy dokumentów przypisane do procesu
List<DocumentClass>	getDocumentClassesForUser(String userName) Pobiera listę klas dokumentów do których podany użytkownik może dodawać dokumenty
List<DocumentClass>	getDocumentClassesForUser(String userName, boolean withAddingRight) Pobiera listę klas dokumentów do których podany użytkownik ma uprawnienia do odczytu lub dodawania dokumentów (w zależności od parametru)
List<DocumentClass>	getDocumentClassesForUser(String userName, DocumentUploadSource uploadSource) Pobiera listę klas dokumentów do których użytkownik może dodawać dokumentu na konkretnym poziomie (archiwum lub proces)
List<DocumentClass>	getDocumentClassesForUserAndProcess(String userName, String processDefId) Pobiera listę klas dokumentów do których użytkownik może dodawać dokument w konkretnym procesie
List<DocumentClass>	getDocumentClassesForUserAndProcess(String userName, String processDefId, boolean withAddingRight) Pobiera listę klas dokumentów do których podany użytkownik ma uprawnienia do odczytu lub dodawania dokumentów (w zależności od parametru) w konkretnym procesie
String	getFullPathForDocClass(Long docClassId) Pobiera ścieżkę do katalogu klasy dokumentów (dla dynamicznie tworzonych nazw katalogów nazwa generowana jest na podstawie aktualnej daty)
void	removeActionFromDocumentClass(Long docClassId, String actionName) Usuwa akcje z klasy dokumentów
void	removeIndexFromDocumentClass(Long docClassId, String indexName) Usuwa indeks z klasy dokumentów
void	updateDocumentClass(DocumentClass dc) Modyfikuje klasę dokumentów
void	updateDocumentClassAssociation(DocumentClassAssociation documentClassAssociation) Modyfikuje powiązanie między klasami dokumentów w bazie danych.
DocumentClassIndex	updateIndexInDocumentClass(Long docClassId, DocumentClassIndex index) Aktualizuje indeks klasy dokumentów

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

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

Method Detail

createDocumentClass

void createDocumentClass(DocumentClass dc)

Zapisuje klasa dokumentów w bazie danych. Tworzy tabele przechowującą indeksy dla utworzonej klasy

Parameters:

dc - Definicja klasy dokumentów

deleteDocumentClass

void deleteDocumentClass(String name)

Usuwa klasę dokumentów

Parameters:

name - Nazwa klasy dokumentów

deleteDocumentClass

void deleteDocumentClass(Long documentClassId)

Usuwa klasę dokumentów

Parameters:

documentClassId - Id klasy dokumentów

addIndexToDocumentClass

void addIndexToDocumentClass(Long docClassId,
                             DocumentClassIndex index)

Dodaje indeks do klasy dokumentów

Parameters:

docClassId - Id klasy dokumentów

index - Definicja indeksu

updateIndexInDocumentClass

DocumentClassIndex updateIndexInDocumentClass(Long docClassId,
                                              DocumentClassIndex index)

Aktualizuje indeks klasy dokumentów

Parameters:

docClassId - id klasy dokumentów

index - definicja indeksu

removeIndexFromDocumentClass

void removeIndexFromDocumentClass(Long docClassId,
                                  String indexName)

Usuwa indeks z klasy dokumentów

Parameters:

docClassId - Id klasy dokumentów

indexName - Nazwa indeksu

addActionToDocumentClass

void addActionToDocumentClass(Long docClassId,
                              DocumentClassAction action)

Dodaje akcje do klasy dokumentów

Parameters:

docClassId - Id klasy dokumentów

action - Definicja akcji

removeActionFromDocumentClass

void removeActionFromDocumentClass(Long docClassId,
                                   String actionName)

Usuwa akcje z klasy dokumentów

Parameters:

docClassId - Id klasy dokumentów

actionName - Nazwa akcji

getDocumentClass

DocumentClass getDocumentClass(String name,
                               String... joins)

Pobiera obiekt klasy dokumentów

Parameters:

name - Nazwa klasy dokumentów

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

Returns:

Zwraca klasa dokumentów o podanej nazwie

getFullPathForDocClass

String getFullPathForDocClass(Long docClassId)

Pobiera ścieżkę do katalogu klasy dokumentów (dla dynamicznie tworzonych nazw katalogów nazwa generowana jest na podstawie aktualnej daty)

Parameters:

docClassId - Id klasy dokumentów

Returns:

Zwraca pełną ścieżkę do katalogu klasy dokumentów

getDocumentClassDirectory

File getDocumentClassDirectory(Long docClassId)

Pobiera katalog klasy dokumentów (dla dynamicznie tworzonych nazw katalogów nazwa generowana jest na podstawie aktualnej daty)

Parameters:

docClassId - Id klasy dokumentów

Returns:

Zwraca katalog klasy dokumentów

updateDocumentClass

void updateDocumentClass(DocumentClass dc)

Modyfikuje klasę dokumentów

Parameters:

dc - Obiekt klasy dokumentów

getDocumentClassesForUser

List<DocumentClass> getDocumentClassesForUser(String userName)

Pobiera listę klas dokumentów do których podany użytkownik może dodawać dokumenty

Parameters:

userName - Login użytkownika

Returns:

lista klas dokumentów

getDocumentClassesForUser

List<DocumentClass> getDocumentClassesForUser(String userName,
                                              boolean withAddingRight)

Pobiera listę klas dokumentów do których podany użytkownik ma uprawnienia do odczytu lub dodawania dokumentów (w zależności od parametru)

Parameters:

userName - Login użytkownika

withAddingRight - określa, czy użytkownik musi mieć uprawnienia do dodawania dokumentów do tych klas

Returns:

lista klas dokumentów

getDocumentClassesForUserAndProcess

List<DocumentClass> getDocumentClassesForUserAndProcess(String userName,
                                                        String processDefId,
                                                        boolean withAddingRight)

Pobiera listę klas dokumentów do których podany użytkownik ma uprawnienia do odczytu lub dodawania dokumentów (w zależności od parametru) w konkretnym procesie

Parameters:

userName - login użytkownika

processDefId - definicja procesu

withAddingRight - określa, czy użytkownik musi mieć uprawnienia do dodawania dokumentów do tych klas

Returns:

lista klas dokumentów

getDocumentClassesForUser

List<DocumentClass> getDocumentClassesForUser(String userName,
                                              DocumentUploadSource uploadSource)

Pobiera listę klas dokumentów do których użytkownik może dodawać dokumentu na konkretnym poziomie (archiwum lub proces)

Parameters:

userName - login użytkownika

uploadSource - poziom dodawania dokumentu

Returns:

getDocumentClassesForProcess

List<DocumentClass> getDocumentClassesForProcess(String processDefId)

Pobiera klasy dokumentów przypisane do procesu

Parameters:

processDefId - Definicja procesu

Returns:

Lista klas dokumentów przypisanych do definicji procesu

getDocumentClassesForUserAndProcess

List<DocumentClass> getDocumentClassesForUserAndProcess(String userName,
                                                        String processDefId)

Pobiera listę klas dokumentów do których użytkownik może dodawać dokument w konkretnym procesie

Parameters:

userName - login użytkownika

processDefId - definicja procesu

Returns:

lista klas dokumentów

executePatterns

Map<Long,Object> executePatterns(Map<Long,Object> indexes)

Aktualizuje indeksy względem przypisanych wzorców.

Parameters:

indexes - mapa indeksów

Returns:

nowa mapa indeksów

createDocumentClassAssociation

void createDocumentClassAssociation(DocumentClassAssociation documentClassAssociation)

Zapisuje powiązanie między klasami dokumentów w bazie danych.

Parameters:

documentClassAssociation - Definicja powiązania między klasami dokumentów

deleteDocumentClassAssociation

void deleteDocumentClassAssociation(DocumentClassAssociation documentClassAssociation)

Usuwa powiązanie między klasami dokumentów w bazie danych.

Parameters:

documentClassAssociation - Definicja powiązania między klasami dokumentów

deleteDocumentClassAssociationById

void deleteDocumentClassAssociationById(Long associationId)

Usuwa powiązanie między klasami dokumentów w bazie danych.

Parameters:

associationId - Identyfikator powiązania między klasami dokumentów

updateDocumentClassAssociation

void updateDocumentClassAssociation(DocumentClassAssociation documentClassAssociation)

Modyfikuje powiązanie między klasami dokumentów w bazie danych.

Parameters:

documentClassAssociation - Definicja powiązania między klasami dokumentów

getAssociatedDocumentsFromClass

CountedResult<WfDocument> getAssociatedDocumentsFromClass(Long documentClassId,
                                                          Long documentId,
                                                          Long childDocumentClassId,
                                                          Integer start,
                                                          Integer limit,
                                                          String sort,
                                                          String dir,
                                                          String userName)

Pobiera listę dokumentów powiązanych należących do klasy przekazanej w parametrze childDocumentClassId

Parameters:

documentClassId - Id klasy dokumentu dla którego szukamy powiązań

documentId - Id dokumentu dla którego szukamy powiązań

childDocumentClassId - Klasa dokumentów w której szukamy powiązanych dokumentów

start - Wartość początkowa zbioru wynikowego

limit - Wartość końcowa zbioru wynikowego

sort - Parametr po którym posortowany zostanie zbiór wynikowy

dir - Kierunek sortowania - 'ASC' lub 'DESC'

userName - Login użytkownika wyszukującego powiązania

getAllAssociatedDocumentsForClass

List<WfDocument> getAllAssociatedDocumentsForClass(Long documentClassId,
                                                   Long documentId,
                                                   String userName)

Pobiera listę wszystkich dokumentów powiązanych dla dokumentu o Id przekazanym w parametrze documentId.

Parameters:

documentClassId - Id klasy dokumentu dla którego szukamy powiązań

documentId - Id dokumentu dla którego szukamy powiązań

userName - Login użytkownika wyszukującego powiązania