com.suncode.pwfl.archive

Interface DocumentService

public interface DocumentService

Umożliwia zarządzanie dokumentami systemu.

Author:

Paweł Rosolak 20 gru 2013

Method Summary

Modifier and Type	Method and Description
WfDocument	addDocument(DocumentDefinition definition) Dodaje dokument do systemu
AddDocumentResultMeta	addDocumentWithMetaResult(DocumentDefinition definition) Dodaje dokument do systemu
void	attachDocumentToProcess(Long documentId, Long documentClassId, String userName, String processId, String activityId) Dołącza dokument istniejący w archiwum do procesu
void	attachDocumentToProcess(WfDocument document, String userName, String processId, String activityId) Dołącza dokument istniejący w archiwum do procesu
void	deleteAllDocumentVersions(WfDocument document)
void	deleteDocument(Long documentId, Long documentClassId) Usuwa dokument z systemu
void	deleteDocument(WfDocument document) Usuwa dokument z systemu
void	detachDocumentFromActivity(WfDocument document, String processId, String activityId) Odłącza dokument od zadania.
void	detachDocumentFromProcess(Long documentId, Long documentClassId, String processId) Odłącza dokument od procesu.
void	detachDocumentFromProcess(WfDocument document, String processId) Odłącza dokument od procesu.
WfDocument	getDocument(Long fileId) Pobiera dokument za pomocą fileId(z pm_files)
WfDocument	getDocument(Long documentId, Long documentClassId) Pobiera dokument po id
void	updateDocument(WfDocument document) Modyfikuje dokument (aktualnie zmienia wyłącznie indeksy dokumnetu)

Method Detail

addDocument

WfDocument addDocument(DocumentDefinition definition)

Dodaje dokument do systemu

Parameters:

definition - Definicja dokumentu

Returns:

Dodany dokument

addDocumentWithMetaResult

AddDocumentResultMeta addDocumentWithMetaResult(DocumentDefinition definition)

Dodaje dokument do systemu

Parameters:

definition -

Returns:

zwraca również informację, czy dokument został dodany jako nowa wersja

getDocument

WfDocument getDocument(Long documentId,
                       Long documentClassId)

Pobiera dokument po id

Parameters:

documentId - Id dokumentu(z pm_idx000x)

Returns:

Definicja dokumentu

updateDocument

void updateDocument(WfDocument document)

Modyfikuje dokument (aktualnie zmienia wyłącznie indeksy dokumnetu)

Parameters:

document - Definicja dokumentu

deleteDocument

void deleteDocument(Long documentId,
                    Long documentClassId)

Usuwa dokument z systemu

Parameters:

documentId - Id dokumentu(z pm_idx000x)

deleteDocument

void deleteDocument(WfDocument document)

Usuwa dokument z systemu

Parameters:

Definicja - dokumentu

deleteAllDocumentVersions

void deleteAllDocumentVersions(WfDocument document)

detachDocumentFromProcess

void detachDocumentFromProcess(Long documentId,
                               Long documentClassId,
                               String processId)

Odłącza dokument od procesu. Pozostawia go w archiwum.

Parameters:

documentId - Id dokumentu(z pm_idx000x)

processId - Id procesu

activityId - Id zadania

detachDocumentFromProcess

void detachDocumentFromProcess(WfDocument document,
                               String processId)

Odłącza dokument od procesu. Pozostawia go w archiwum.

Parameters:

document - Definicja dokumentu

processId - id procesu

detachDocumentFromActivity

void detachDocumentFromActivity(WfDocument document,
                                String processId,
                                String activityId)

Odłącza dokument od zadania. Pozostawia go w archiwum.

Parameters:

document - Definicja dokumentu

processId - Id procesu

activityId - Id zadania

attachDocumentToProcess

void attachDocumentToProcess(Long documentId,
                             Long documentClassId,
                             String userName,
                             String processId,
                             String activityId)

Dołącza dokument istniejący w archiwum do procesu

Parameters:

documentId - Id dokumentu

documentClassId - Id klasy dokumentów

userName - Login użytkownika dołączającego dokument

processId - Id procesu

activityId - Id zadania

attachDocumentToProcess

void attachDocumentToProcess(WfDocument document,
                             String userName,
                             String processId,
                             String activityId)

Dołącza dokument istniejący w archiwum do procesu

Parameters:

document - Definicja dokumentu

userName - Login użytkownika dołączającego dokument

processId - Id procesu

activityId - Id zadania

getDocument

WfDocument getDocument(Long fileId)

Pobiera dokument za pomocą fileId(z pm_files)

Parameters:

fileId - Id pliku

Returns:

Dokument