com.suncode.pwfl.workflow.activity

Interface ActivityService

public interface ActivityService

Umożliwia zarządzanie zadaniami.

Author:

Paweł Rosolak 04-10-2012

Method Summary

Modifier and Type	Method and Description
void	acceptActivity(AcceptationDefinition definition) Akceptuje zadanie.
void	addActivityDelegation(DelegatedActivity da) Dodaje zastępstwo
void	changeState(String processId, String activityId, ActivityState state) Zmienia status zadania
boolean	changeStateIfPossible(String processId, String activityId, ActivityState state) Zmienia status zadania, jeżeli obecny status można zmienić na nowy.
Activity	getActivity(String processId, String activityId, String... joins) Pobiera informacje o zadaniu
Map<String,Object>	getActivityContext(String processId, String activityId) Metoda służy do pobierania kontekst mapy zadania(zawiera wszystkie zmienne i ich wartości z zadania)
DelegatedActivity	getActivityDelegation(String activityId, String userName) Pobiera informacje o zastępstwie
String	getActivityName(String processDefId, String activityDefId)
List<String>	getAssignments(String processId, String activityId) Pobiera informacje o przypisanych do zadania użytkownikach
void	openActivity(String userName, String userPassword, String processId, String activityId) Uruchamia zadanie jako podany użytkownik.
void	openActivity(String domain, String userName, String userPassword, String processId, String activityId) Uruchamia zadanie jako podany użytkownik.
void	setActivityContext(String processId, String activityId, Map<String,Object> activityContext) Ustawia mapę zmiennych zadania

Method Detail

openActivity

void openActivity(String userName,
                  String userPassword,
                  String processId,
                  String activityId)
           throws UserIsNotAssignedToActivityException,
                  ActivityAlreadyCompletedException,
                  ActivityIsSuspendedException

Uruchamia zadanie jako podany użytkownik. Po zakończeniu funkcji, zadanie zmienia status na uruchomione.

Parameters:

userName - Login użytkownika, którym chcemy uruchomić zadanie

userPassword - Hasło użytkownika

processId - Id procesu

activityId - Id zadania

Throws:

UserIsNotAssignedToActivityException

ActivityAlreadyCompletedException

ActivityIsSuspendedException

openActivity

void openActivity(String domain,
                  String userName,
                  String userPassword,
                  String processId,
                  String activityId)
           throws Exception

Uruchamia zadanie jako podany użytkownik. Po zakończeniu funkcji, zadanie zmienia status na uruchomione.

Parameters:

domain - Domena użytkownika

userName - Login użytkownika, którym chcemy uruchomić zadanie

userPassword - Hasło użytkownika

processId - Id procesu

activityId - Id zadania

Throws:

Exception

setActivityContext

void setActivityContext(String processId,
                        String activityId,
                        Map<String,Object> activityContext)

Ustawia mapę zmiennych zadania

Parameters:

processId - Id procesu

activityId - Id zadania

activityContext - Mapa zmiennych zadania

getActivityContext

Map<String,Object> getActivityContext(String processId,
                                      String activityId)

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

Parameters:

processId - Id procesu

activityId - Id zadania

Returns:

Zwaraca mapę zmiennych zadania

getActivity

Activity getActivity(String processId,
                     String activityId,
                     String... joins)

Pobiera informacje o zadaniu

Parameters:

activityId - Id zadania

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

Returns:

Zwraca informacje o zadaniu

getActivityDelegation

DelegatedActivity getActivityDelegation(String activityId,
                                        String userName)

Pobiera informacje o zastępstwie

Parameters:

activityId - Id zadania

userName - Użytkownik, który zastępuje pierwotnego użytkownika

Returns:

Zwraca null jeżeli podany użytkownik nie jest zastępcą w tym zadaniu

addActivityDelegation

void addActivityDelegation(DelegatedActivity da)

Dodaje zastępstwo

Parameters:

da - Definicja zastępstwa

acceptActivity

void acceptActivity(AcceptationDefinition definition)

Akceptuje zadanie.
Podany użytkownik musi być właścicielem tego zadania lub przynajmniej być jednym z przypisanych do niego użytkowników. Ustawienie parametru ignoreOwnerShip decyduje, która opcja musi być spełniona.

Parameters:

activityId - Id zadania

processId - Id procesu

userName - Nazwa użytkownika

actionName - Nazwa przycisku akceptacyjnego z zadania

contextMap - Mapa wartości zmiennych, którą chcemy ustawić przed wykonaniem zadania

ignoreOwnerShip - Ustawienie czy ignorować właściciela zadania.
false - wtedy podany użytkownik musi być właścicielem zadania tj. zadanie musiało zostać przez niego otwarte, co w praktyce oznacza, że jest jedynym użytkownikiem przypisanym do tego zadania oraz zadanie ma status ActivityState.RUNNING.
true - wtedy podany użytkownik nie musi być właścicielem zadania. Wystarczy, że jest jednym z przypisanych do tego zadania użytkowników tj. w praktyce widzi to zadanie na liście swoich zadać. Wtedy metoda ta ustawi tego użytkownika jako właściciela (jedyne przypisanie+status) i następnie wykona akceptację tego zadania.

i18nXpdl - Obiekt tłumaczeń
Uwaga, aby podczas akceptacji nie leciały wyjątki dot. powiadomień, to ta metoda nie może być wywoływana na tej samej transakcji co tworzenie procesu dot zadania, które tu chcemy akceptować.

getAssignments

List<String> getAssignments(String processId,
                            String activityId)

Pobiera informacje o przypisanych do zadania użytkownikach

Parameters:

activityId - Id zadania

Returns:

Zwraca listę loginów użytkowników przypisanych do zadania

getActivityName

String getActivityName(String processDefId,
                       String activityDefId)

changeState

void changeState(String processId,
                 String activityId,
                 ActivityState state)

Zmienia status zadania

Parameters:

processId - Id procesu

activityId - Id zadania

state - Status zadania, który chcemy ustawić

changeStateIfPossible

boolean changeStateIfPossible(String processId,
                              String activityId,
                              ActivityState state)

Zmienia status zadania, jeżeli obecny status można zmienić na nowy. W odróżnieniu do {changeState(String, String, ActivityState) jeżeli nie można zmienić statusu z powodu niekompatybilnego obecnego statusu zadania, nie zostanie rzucony żaden wyjątek. Jedynie w logach będzie informacja, że nie można mienić statusu takiego zadania.

Parameters:

processId - Id procesu

activityId - Id zadania

state - Status zadania, który chcemy ustawić

Returns:

true - jeżeli status został zmieniony, false - jeżeli nie udało się zmienić statusu.

Throws:

ServiceException - Wyjątek rzucony w przypadku nieoczekiwanego błędu.