Moduł Hetman wspiera implementację procesów przy użyciu mechanizmu jPALIO Hetman Workflow. Metody tego modułu można pogrupować w następujące grupy:

• Wykonywanie procesu, programistyczne wykonywanie przejść
• Obsługa kontekstu wykonywania procesu
• Wsparcie tworzenia widoków
• Tworzenie szkieletu aplikacji na podstawie definicji procesu

Metody z tej grupy odpowiedzialne są uruchamianie silnika Hetman w kontekście wykonywania i prezentacji procesu. Do tej grupy można zaliczyć następujące metody:

• executeProcess - Powinna być wywoływana na głównej stronie obsługi procesu. Przykładowe wywołanie zostało przedstawione w rozdziale opisującym Hetmana

• executeTransition - Służy do "ręcznego" wykonania przejścia. Zazwyczaj jest używana do automatycznego wykonywania przejść np. w okresowo wykonujących się zadaniach lub po prostu w celach testowych.

Z kontekstu wykonywania procesu można otrzymać szereg bardzo przydatnych informacji takich jak bieżacy stan procesowanej instancji, czy bieżące przejście. Istnieje możliwość ustawienia dodatkowych parametrów w kontekście wykonywania. Umożliwia to przekazywanie w trakcie wykonywania procesu informacji pomiędzy poszczególnymi komponentami realizującymi dany proces. Do obsługi kontekstu służą następujące metody:

• createProcessExecutionContext - Tworzy nowy kontekst wykonywania procesu i przypisuje go do bieżącego wątku

• getProcessExecutionContext - Pobiera bieżący kontekst wykonywania procesu

• getProcessExecutionContextParam - Pobiera z kontekstu wykonywania procesu parametr o podanej nazwie

Przykład w jaki sposób można pobrać bieżący stan oraz przejście:

ProcessExecutionContext context = Groovy.module("hetman").getProcessExecutionContext()
context.getCurrentState()
context.getCurrentTransition()

Ustawienie parametrów parametrów kontekstu jest możliwe na dwa sposoby. Pierwszym jest przekazanie parametrów kontekstu do metod odpowiedzialnych za uruchamianie silnika Hetmana: executeProcess, executeTransition.

Drugim sposobem jest ustawienie parametru po pobraniu bieżącego kontekstu. Poniższy przykład obrazuje drugi sposób.

ProcessExecutionContext context = Groovy.module("hetman").getProcessExecutionContext()
context.setParam("test", "some value")

Moduł Hetman udostępnia zestaw metod wspierających tworznie widoków w implementacji procesu.
Poniżej opisano kilka najważniejszych metod.

• displayProcess - Metoda jest odpowiedzialna za wyświetlenie wszystkich formatek procesu jakie generowane są przez moduł. Są to formularze przejść możliwych do wykonania w stanie w jakim znajduje się procesowana instancja oraz dodatkowy widok stanu w jakim znajduje się procesowana instancja (widok uzupełniający standardowy widok procesu)

• displayTransitions - Metoda jest odpowiedzialna za wyświetlenie formularzy przejść. Metoda powinna być wywoływana w obiekcie stanowiącym widok stanu procesowanej instancji (<prefix>.view). Metoda wywołuje po kolei wszystkie obiekty formularzy przejść, które mogą zostać wykonane ze stanu w jakim aktualnie znajduje się procesowana instancja.

• displayTransitionButton - Wyświetla przycisk typu submit, który będzie mógł wyzwolić wykonanie przejścia do stanu docelowego. Metoda ta powinna być wywoływana w obiekcie formularza związanego z docelowym stanem (<prefix>.<identyfikator docelowego stanu>.form). Nazwa przycisku ma wartość "HTransition_", natomiast labelką jest wartość atrybutu label.


• displayTransitionButtonName - Wyświetla nazwę przycisku zamiast całego przycisku

• displayTransitionHiddenField - Wyświetla pole typu hidden, dzięki któremu formularz, w którym to pole zostało umieszczone będzie mógł wyzwolić wykonanie przejścia do stanu docelowego. Metoda ta powinna być wywoływana w obiekcie formularza związanego z docelowym stanem (<prefix>.<identyfikator docelowego stanu>.form). Nazwa pola ma wartość "HTransition". Jako wartość ustawiona jest identyfikator stanu docelowego.

• getTransitionsForDopList - Zwraca listę przejść jakie mogą zostać wykonane ze stanu w jakim obecenie znajduje się procesowana instancja. Lista ta może zostać użyta jako dane to listy rozwijanej. Wartością jest identyfikator stanu, natomiast labelką jest wartość atrybutu label, w definicji przejścia. Lista rozwijana musi mieć nazwę HTransition.

Moduł Hetman wspiera tworzenie szkieletu implementacji procesu na podstawie wskazanego dokumentu XML z definicją procesu. Aby stworzyć szkielet należy wywołać metodę createProcessTemplate.

Przykładowo dla procesu opisanego w sposób następujący:

<?xml version="1.0" encoding="UTF-8"?>
<process name="sample.process" prefix="sample.process" manager="sample.process.SampleProcessManager">

<states>
<state id="state1">
    <transitions>
        <transition destination="state2"/>
    </transitions>
</state>

<state id="state2">
    <transitions>
        <transition destination="state3"/>
        <transition destination="state4"/>
    </transitions>
</state>

<state id="state3">
    <transitions>
        <transition destination="state4"/>
    </transitions>
</state>

<state id="state4"/>
</states>
</process>

http://docs.torn.com.pl/modules/palio/modules/Hetman.html