com.suncode.pwfl.workflow.process

Interface ProcessService

public interface ProcessService

Umożliwia zarządzanie procesami.

Author:

Paweł Rosolak 19-10-2012

Method Summary

Modifier and Type	Method and Description
ProcessDocumentClass	addDocClassToProcess(String processDefId, DocumentClass docClass) Dodaje klasę dokumentu, która będzie dostępna w procesie
String	createProcess(ProcessBuilderDefinition pbd) Tworzy nowy proces o podanych parametrach
CreateProcessResult	createProcessWithResult(ProcessBuilderDefinition pbd) Tworzy nowy proces o podanych parametrach
void	deleteDocClassFromAllProcesses(Long documentClassId) Usuwa przypisanie klasy dokumentu do definicji wszystkich procesów
void	deleteDocClassFromProcess(Long procDocClassId) Usuwa przypisanie klasy dokumentu do definicji procesu
void	deleteProcess(String processId) Usuwa proces
void	deleteProcesses(List<String> processIds) Usuwa procesy o podanych id
List<ActivityType>	getActivityTypes(String processDefId) Pobiera typy zadań dla podanego procesu
List<ProcessType>	getAllProcessTypes(boolean allVersions) Pobiera informacje o dostępnych typach procesów z aktualnie załadowanych pakietów.
List<WfParticipant>	getParticipantsFromProcess(String processDefId) Pobiera listę ról z procesu
Process	getProcess(String processId, String... joins) Pobiera informacje o procesie
Map<String,Object>	getProcessContext(String processId) Metoda służy do pobierania kontekst mapy procesu(zawiera wszystkie zmienne i ich wartości z procesu)
List<ProcessDocumentClass>	getProcessDefDocumentClasses(String processDefId) Pobiera klasy dokumentów przypisane do definicji procesu
ProcessDefinition	getProcessDefinition(String processDefId) Pobiera definicję procesu
List<ProcessIndex>	getProcessIndexes(String processDefId) Pobiera definicję indeksów procesu
List<ProcessType>	getProcessTypesForUser(String userName) Pobiera informacje o dostępnych typach procesów z aktualnie załadowanych pakietów.
Map<String,List<ActivityType>>	getRoleActivityMap(String processDefId) Pobiera mapę w której kluczem jest id roli a wartość to lista obiektów zawierajacych informajce o zadaniach w obrębie roli.
void	setProcessContext(String processId, Map<String,Object> contextMap) Ustawia mapę zmiennych procesu
void	startProcess(String processId) Uruchamia proces o podany identyfikatorze.

Method Detail

getProcess

Process getProcess(String processId,
                   String... joins)

Pobiera informacje o procesie

Parameters:

processId - Id procesu

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

Returns:

Zwraca informacje o procesie

getProcessContext

Map<String,Object> getProcessContext(String processId)

Metoda służy do pobierania kontekst mapy procesu(zawiera wszystkie zmienne i ich wartości z procesu)

Parameters:

processId - Id procesu

Returns:

Zwraca mapę zmiennych zadania

setProcessContext

void setProcessContext(String processId,
                       Map<String,Object> contextMap)

Ustawia mapę zmiennych procesu

Parameters:

processId - Id procesu

contextMap - Nowa mapa zmiennych procesu

deleteProcess

void deleteProcess(String processId)

Usuwa proces

Parameters:

processId - Id procesu

getProcessDefinition

ProcessDefinition getProcessDefinition(String processDefId)

Pobiera definicję procesu

Parameters:

processDefId - - Id definicji procesu

Returns:

Zwraca definicję procesu

getAllProcessTypes

List<ProcessType> getAllProcessTypes(boolean allVersions)

Pobiera informacje o dostępnych typach procesów z aktualnie załadowanych pakietów.

Parameters:

allVersions - true - jeżeli pobierać typy procesów również ze starszych wersji pakietów, false jeżeli pobierać tylko z aktualnie załadowanych pakietów.

Returns:

Lista typów procesów

getProcessTypesForUser

List<ProcessType> getProcessTypesForUser(String userName)

Pobiera informacje o dostępnych typach procesów z aktualnie załadowanych pakietów. Dla podanego użytkownika

Parameters:

userName - Login użytkownika

Returns:

Lista typów procesów

getActivityTypes

List<ActivityType> getActivityTypes(String processDefId)

Pobiera typy zadań dla podanego procesu

Parameters:

processDefId - Id definicji procesu

Returns:

getParticipantsFromProcess

List<WfParticipant> getParticipantsFromProcess(String processDefId)

Pobiera listę ról z procesu

Parameters:

processDefId - Id definicji procesu

Returns:

getRoleActivityMap

Map<String,List<ActivityType>> getRoleActivityMap(String processDefId)

Pobiera mapę w której kluczem jest id roli a wartość to lista obiektów zawierajacych informajce o zadaniach w obrębie roli.

Parameters:

processDefId - Id definicji procesu

Returns:

createProcess

String createProcess(ProcessBuilderDefinition pbd)

Tworzy nowy proces o podanych parametrach

Parameters:

pbd - Defnicji nowego procesu

Returns:

Id utworzonego procesu

Throws:

Exception

createProcessWithResult

CreateProcessResult createProcessWithResult(ProcessBuilderDefinition pbd)

Tworzy nowy proces o podanych parametrach

Parameters:

pbd - Defnicji nowego procesu

Returns:

Obiekt zawierający informacje o utworzonym procesie

startProcess

void startProcess(String processId)

Uruchamia proces o podany identyfikatorze.

Parameters:

processId - identyfikator uruchamianego procesu

Throws:

getProcessIndexes

List<ProcessIndex> getProcessIndexes(String processDefId)

Pobiera definicję indeksów procesu

Parameters:

processDefId - Id definicji procesu

Returns:

Lista definicji indeksów

deleteProcesses

void deleteProcesses(List<String> processIds)

Usuwa procesy o podanych id

Parameters:

processIds - Id procesów

getProcessDefDocumentClasses

List<ProcessDocumentClass> getProcessDefDocumentClasses(String processDefId)

Pobiera klasy dokumentów przypisane do definicji procesu

Parameters:

processDefId - Definicja procesu

Returns:

Lista klas dokumentów przypisanych do definicji procesu

addDocClassToProcess

ProcessDocumentClass addDocClassToProcess(String processDefId,
                                          DocumentClass docClass)

Dodaje klasę dokumentu, która będzie dostępna w procesie

Parameters:

processDefId - Definicja procesu

docClass - klasa dokumentu

Returns:

obiekt reprezentujący przypisanie klasy dokumentu do definicji procesu

deleteDocClassFromProcess

void deleteDocClassFromProcess(Long procDocClassId)

Usuwa przypisanie klasy dokumentu do definicji procesu

Parameters:

procDocClassId - id przypisania klasy dokumentu do procesu

deleteDocClassFromAllProcesses

void deleteDocClassFromAllProcesses(Long documentClassId)

Usuwa przypisanie klasy dokumentu do definicji wszystkich procesów

Parameters:

procDocClassId - id przypisania klasy dokumentu do procesu