palio.modules
Class Hetman

java.lang.Object
  palio.modules.core.Module
      palio.modules.Hetman

All Implemented Interfaces:

palio.modules.core.CurrentModuleDataKeys

public class Hetman
extends palio.modules.core.Module

Moduł Hetman wspiera tworzenie, implementację procesów (workflow).

Version:

3.0.3

Author:

Krzysztof Madyniak (kmadyniak@torn.com.pl)

Field Summary

static java.lang.String	ERROR_MESSAGE_CSS_CLASS
static java.lang.String	MESSAGE_CSS_CLASS
static java.lang.String	TRANSITION_BUTTON_CSS_CLASS

Fields inherited from interface palio.modules.core.CurrentModuleDataKeys

DESIGNER_ACTIONS_BUFFER, HTML_FORM_BUILDER, HTML_MAP_BUILDER, HTML_MENU_BUILDER, HTML_TOOLTIPS_BUFFER, ITEXT_DOCUMENT, MAIL_MESSAGE, XLS_DOCUMENT, XML_DOCUMENT

Constructor Summary

Hetman(palio.Instance instance, java.util.Properties parameters)

Method Summary

void	createProcessExecutionContext(java.lang.String processName, java.lang.Object instanceId, java.util.Map<java.lang.String,java.lang.Object> contextParams) Tworzy "sztuczny" kontekst wykonywania procesu
void	createProcessTemplate(java.lang.String xml) Tworzy szablon implementacji procesu na podstawie podanej definicji
static void	displayProcess() Metoda jest odpowiedzialna za wyświetlenie wszystkich formatek procesu jakie generowane są przez moduł.
static void	displayTransitionButton(java.lang.String destinationStateId) Wyświetla przycisk typu submit, który będzie mógł wyzwolić wykonanie przejścia do stanu destinationStateName.
static void	displayTransitionButton(java.lang.String destinationStateId, java.lang.String cssClass) Wyświetla przycisk typu submit, który będzie mógł wyzwolić wykonanie przejścia do stanu destinationStateName.
static void	displayTransitionButton(java.lang.String destinationStateId, java.lang.String label, java.lang.String cssClass) Wyświetla przycisk typu submit, który będzie mógł wyzwolić wykonanie przejścia do stanu destinationStateName.
static void	displayTransitionButtonName(java.lang.String destinationStateId) Wyświetla warość name zamiast całego przycisku
static void	displayTransitionHiddenField(java.lang.String destinationStateId) 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 destinationStateName.
static void	displayTransitions() Metoda jest odpowiedzialna za wyświetlenie formularzy przejść.
void	executeProcess(java.lang.String processName, java.lang.Object instanceId) Główna metoda modułu.
void	executeProcess(java.lang.String processName, java.lang.Object instanceId, java.util.Map<java.lang.String,java.lang.Object> contextParams) Główna metoda modułu.
palio.modules.hetman.Result	executeTransition(java.lang.String processName, java.lang.Object instanceId, java.lang.String destinationStateId)
palio.modules.hetman.Result	executeTransition(java.lang.String processName, java.lang.Object instanceId, java.lang.String destinationStateId, java.lang.Boolean createOwnTransaction)
palio.modules.hetman.Result	executeTransition(java.lang.String processName, java.lang.Object instanceId, java.lang.String destinationStateId, java.util.Map<java.lang.String,java.lang.Object> contextParams)
palio.modules.hetman.Result	executeTransition(java.lang.String processName, java.lang.Object instanceId, java.lang.String destinationStateId, java.util.Map<java.lang.String,java.lang.Object> contextParams, java.lang.Boolean createOwnTransaction) Wykonuje przejścia w danym procesie na podanej instancji
static java.lang.String	fromUML(java.lang.String processName, java.lang.String processPrefix, java.lang.String processManager, java.lang.String inputXml) Konwertuje definicję procesu w formacie UML(?)
palio.modules.hetman.HetmanManager	getManager() Zwraca menadżera modułu Hetman.
static palio.modules.hetman.ProcessExecutionContext	getProcessExecutionContext() Metoda zwraca kontekst wykonywania się procesu.
static java.lang.Object	getProcessExecutionContextParam(java.lang.String name) Pobiera wartość parametru z konekstu wykonywania procesu
java.util.ArrayList<java.lang.String>	getSourceStates(java.lang.String processName, java.lang.Object[] destinationStatesIds) Zwraca listę identyfikatorów stanów z jakich można wykonać przejście do określonych stanów.
java.util.ArrayList<java.lang.String>	getSourceStates(java.lang.String processName, java.lang.String destinationStateId) Zwraca listę identyfikatorów stanów z jakich można wykonać przejście do określonego stanu.
java.lang.Object	getStateParamValue(java.lang.String processName, java.lang.String stateId, java.lang.String paramName) Zwraca wartość predefiniowanego parametru stanu
java.util.ArrayList<java.lang.String>	getStatesAfter(java.lang.String processName, java.lang.String refStateId, java.lang.Boolean includeRefState) Zwraca listę identyfikatorów wszystkich stanów jakie mogą wystąpić po stanie o podanej nazwie.
java.util.ArrayList<java.lang.String>	getStatesBefore(java.lang.String processName, java.lang.String refStateId, java.lang.Boolean includeRefState) Zwraca listę identyfikatorów wszystkich stanów jakie mogą wystąpić przed stanem o podanej nazwie.
java.util.ArrayList<java.lang.String>	getSubprocessStates(java.lang.String processName, java.lang.String subprocessName, java.lang.Boolean includeLastNoSuccessStates) Zwraca listę identyfikatorów stanów wchodzących w skład podprocesu o podanej nazwie
java.lang.Object	getTransitionParamValue(java.lang.String processName, java.lang.String sourceStateId, java.lang.String destinationStateId, java.lang.String paramName) Zwraca wartość predefiniowanego parametru przejścia
static java.util.LinkedList<java.lang.Object[]>	getTransitionsForDropList() Zwraca listę przejść jakie mogą zostać wykonane ze stanu w jakim obecenie znajduje się procesowana instancja.
static java.util.LinkedList<java.lang.Object[]>	getTransitionsForDropList(java.lang.String groupName, java.lang.Boolean checkPossibility) Zwraca listę przejść jakie mogą zostać wykonane ze stanu w jakim obecenie znajduje się procesowana instancja.
java.lang.String	getVersion() Returns the module version
java.lang.Boolean	isSubprocessFinished(java.lang.String processName, java.lang.Long instanceId, java.lang.String subprocessName) Sprawdza czy dla procesowanej instancji skończył się podproces o podanej nazwie.
java.lang.Boolean	isSubprocessFinishedSuccessfully(java.lang.String processName, java.lang.Long instanceId, java.lang.String subprocessName) Sprawdza czy dla procesowanej instancji skończył się z powodzeniem podproces o podanej nazwie.
static java.lang.Boolean	isTransitionPossible(java.lang.String destinationStateId) Sprawdza czy jest możliwość wykonania przejścia do określonego stanu w wykonywnym kontekscie procesu (w obecnym stanie)
static palio.modules.hetman.Result	newResult(java.lang.Boolean success) Funkcja tworzy obiekt typu Result używany w obiektach Action i Condition.
static palio.modules.hetman.Result	newResult(java.lang.Boolean success, java.lang.String message) Funkcja tworzy obiekt typu Result używany w obiektach Action i Condition.
static palio.modules.hetman.Result	newResult(java.lang.Boolean success, java.lang.String message, java.lang.String errorMessage) Funkcja tworzy obiekt typu Result używany w obiektach Action i Condition.
static void	setAutoTransition(java.lang.String destinationStateId) Ustawia przejście jakie ma zostać automatycznie wykonane po wykonaniu aktualnego przejścia.

Methods inherited from class palio.modules.core.Module

getConfigParam, getDescription, getModuleTranslation

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MESSAGE_CSS_CLASS

public static final java.lang.String MESSAGE_CSS_CLASS

See Also:

Constant Field Values

ERROR_MESSAGE_CSS_CLASS

public static final java.lang.String ERROR_MESSAGE_CSS_CLASS

See Also:

Constant Field Values

TRANSITION_BUTTON_CSS_CLASS

public static final java.lang.String TRANSITION_BUTTON_CSS_CLASS

See Also:

Constant Field Values

Constructor Detail

Hetman

public Hetman(palio.Instance instance,
              java.util.Properties parameters)
       throws palio.PalioException

Throws:

palio.PalioException

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from class: palio.modules.core.Module

Returns the module version

Specified by:

getVersion in class palio.modules.core.Module

executeProcess

public void executeProcess(java.lang.String processName,
                           java.lang.Object instanceId,
                           java.util.Map<java.lang.String,java.lang.Object> contextParams)
                    throws palio.PalioException,
                           palio.modules.hetman.exceptions.HetmanException,
                           palio.modules.hetman.exceptions.ProcessException

Główna metoda modułu. Odpowiedzialna jest ona za cały mechanizm obłsugi procesu. Metodę tą należy wywoływać w głównej stronie procesu.

Parameters:

processName - nazwa procesu

instanceId - identyfikator procesowanej instancji

contextParams - parametry kontekstu wykonywania procesu

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException

executeProcess

public void executeProcess(java.lang.String processName,
                           java.lang.Object instanceId)
                    throws palio.PalioException,
                           palio.modules.hetman.exceptions.HetmanException,
                           palio.modules.hetman.exceptions.ProcessException

Główna metoda modułu. Odpowiedzialna jest ona za cały mechanizm obłsugi procesu. Metodę tą należy wywoływać w głównej stronie procesu.

Parameters:

processName - nazwa procesu

instanceId - identyfikator procesowanej instancji

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException

createProcessTemplate

public void createProcessTemplate(java.lang.String xml)
                           throws palio.modules.hetman.exceptions.HetmanException,
                                  palio.PalioException

Tworzy szablon implementacji procesu na podstawie podanej definicji

Parameters:

xml - definicja procesu

Throws:

palio.modules.hetman.exceptions.HetmanException

palio.PalioException

Since:

jPALIO 6.10.7, module 3.0.0

fromUML

public static java.lang.String fromUML(java.lang.String processName,
                                       java.lang.String processPrefix,
                                       java.lang.String processManager,
                                       java.lang.String inputXml)
                                throws palio.PalioException

Konwertuje definicję procesu w formacie UML(?) do formatu modułu Hetman

Parameters:

processName - nazwa procesu

processPrefix - prefix obiektów procesu

processManager - nazwa klasy menadżera procesu

inputXml - definicja w formacie UML

Returns:

definicja procesu w formacie modułu Hetman

Throws:

palio.PalioException

Since:

jPALIO 6.10.8, module 3.0.0

executeTransition

public palio.modules.hetman.Result executeTransition(java.lang.String processName,
                                                     java.lang.Object instanceId,
                                                     java.lang.String destinationStateId)
                                              throws palio.PalioException,
                                                     palio.modules.hetman.exceptions.HetmanException,
                                                     palio.modules.hetman.exceptions.ProcessException,
                                                     palio.modules.hetman.exceptions.BussinessException

Throws:

palio.PalioException

palio.modules.hetman.exceptions.HetmanException

palio.modules.hetman.exceptions.ProcessException

palio.modules.hetman.exceptions.BussinessException

executeTransition

public palio.modules.hetman.Result executeTransition(java.lang.String processName,
                                                     java.lang.Object instanceId,
                                                     java.lang.String destinationStateId,
                                                     java.lang.Boolean createOwnTransaction)
                                              throws palio.PalioException,
                                                     palio.modules.hetman.exceptions.HetmanException,
                                                     palio.modules.hetman.exceptions.ProcessException,
                                                     palio.modules.hetman.exceptions.BussinessException

Throws:

palio.PalioException

palio.modules.hetman.exceptions.HetmanException

palio.modules.hetman.exceptions.ProcessException

palio.modules.hetman.exceptions.BussinessException

executeTransition

public palio.modules.hetman.Result executeTransition(java.lang.String processName,
                                                     java.lang.Object instanceId,
                                                     java.lang.String destinationStateId,
                                                     java.util.Map<java.lang.String,java.lang.Object> contextParams)
                                              throws palio.PalioException,
                                                     palio.modules.hetman.exceptions.HetmanException,
                                                     palio.modules.hetman.exceptions.ProcessException,
                                                     palio.modules.hetman.exceptions.BussinessException

Throws:

palio.PalioException

palio.modules.hetman.exceptions.HetmanException

palio.modules.hetman.exceptions.ProcessException

palio.modules.hetman.exceptions.BussinessException

executeTransition

public palio.modules.hetman.Result executeTransition(java.lang.String processName,
                                                     java.lang.Object instanceId,
                                                     java.lang.String destinationStateId,
                                                     java.util.Map<java.lang.String,java.lang.Object> contextParams,
                                                     java.lang.Boolean createOwnTransaction)
                                              throws palio.PalioException,
                                                     palio.modules.hetman.exceptions.HetmanException,
                                                     palio.modules.hetman.exceptions.ProcessException,
                                                     palio.modules.hetman.exceptions.BussinessException

Wykonuje przejścia w danym procesie na podanej instancji

Parameters:

processName - nazwa procesu

instanceId - identyfikator procesowanej instancji

destinationStateId - identyfikator docelowego stanu

contextParams - parametry konteksktu wykonywania procesu

createOwnTransaction - flaga określająca czy w ramach przejścia ma być tworzona własna transakcja, czy przejście ma się podczepić do istniejącej transakcji

Throws:

palio.PalioException

palio.modules.hetman.exceptions.HetmanException

palio.modules.hetman.exceptions.ProcessException

palio.modules.hetman.exceptions.BussinessException

Since:

jPALIO 6.10.0, module 2.5.4

newResult

public static palio.modules.hetman.Result newResult(java.lang.Boolean success)

Funkcja tworzy obiekt typu Result używany w obiektach Action i Condition. Funkcja przydatna w obiektach napisanych w języku jPalio.

newResult

public static palio.modules.hetman.Result newResult(java.lang.Boolean success,
                                                    java.lang.String message)

Funkcja tworzy obiekt typu Result używany w obiektach Action i Condition. Funkcja przydatna w obiektach napisanych w języku jPalio.

newResult

public static palio.modules.hetman.Result newResult(java.lang.Boolean success,
                                                    java.lang.String message,
                                                    java.lang.String errorMessage)

Funkcja tworzy obiekt typu Result używany w obiektach Action i Condition. Funkcja przydatna w obiektach napisanych w języku jPalio.

getProcessExecutionContext

public static palio.modules.hetman.ProcessExecutionContext getProcessExecutionContext()
                                                                               throws palio.modules.hetman.exceptions.HetmanException

Metoda zwraca kontekst wykonywania się procesu. Przydatna w obiektach przejścia, warunku napisanych w Groovy. Z obiektu reprezentującego kontekst wykonywania procesu możemy pobrać dane typu: obecny stan zgłoszenia, obecnie wykonywane przejście itd.

Throws:

palio.modules.hetman.exceptions.HetmanException

getProcessExecutionContextParam

public static java.lang.Object getProcessExecutionContextParam(java.lang.String name)
                                                        throws palio.modules.hetman.exceptions.HetmanException

Pobiera wartość parametru z konekstu wykonywania procesu

Parameters:

name - nazwa procesu

Throws:

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpiła próba pobrania parametru, wówczas gdy nie został ustawiony konkekst wykonywania procesu

displayTransitions

public static void displayTransitions()
                               throws palio.PalioException,
                                      palio.modules.hetman.exceptions.HetmanException

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.

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

displayProcess

public static void displayProcess()
                           throws palio.modules.hetman.exceptions.HetmanException,
                                  palio.PalioException

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
• Dodatkowy widok stanu w jakim znajduje się procesowana instancja (widok uzupełniający standardowy widok procesu)

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.PalioException

Since:

jPALIO 6.8.10, module 2.5.0

See Also:

displayTransitions()

displayTransitionButtonName

public static void displayTransitionButtonName(java.lang.String destinationStateId)

Wyświetla warość name zamiast całego przycisku

Parameters:

destinationStateId - identyfikator docelowego stanu

Since:

jPALIO 7.4.32, module 3.0.2

displayTransitionButton

public static void displayTransitionButton(java.lang.String destinationStateId,
                                           java.lang.String label,
                                           java.lang.String cssClass)
                                    throws palio.PalioException,
                                           palio.modules.hetman.exceptions.HetmanException,
                                           palio.modules.hetman.exceptions.ProcessException

Wyświetla przycisk typu submit, który będzie mógł wyzwolić wykonanie przejścia do stanu destinationStateName. 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 w definicji przejścia.

Parameters:

destinationStateId - identyfikator docelowego stanu

label - labelka wyświetlana na przycisku

cssClass - klasa CSS przycisku

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi logiczny błąd w procesie

displayTransitionButton

public static void displayTransitionButton(java.lang.String destinationStateId,
                                           java.lang.String cssClass)
                                    throws palio.PalioException,
                                           palio.modules.hetman.exceptions.HetmanException,
                                           palio.modules.hetman.exceptions.ProcessException

Wyświetla przycisk typu submit, który będzie mógł wyzwolić wykonanie przejścia do stanu destinationStateName. 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 w definicji przejścia.

Parameters:

destinationStateId - identyfikator docelowego stanu

cssClass - klasa CSS przycisku

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi logiczny błąd w procesie

displayTransitionButton

public static void displayTransitionButton(java.lang.String destinationStateId)
                                    throws palio.PalioException,
                                           palio.modules.hetman.exceptions.HetmanException,
                                           palio.modules.hetman.exceptions.ProcessException

Wyświetla przycisk typu submit, który będzie mógł wyzwolić wykonanie przejścia do stanu destinationStateName. 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 w definicji przejścia.

Parameters:

destinationStateId - identyfikator docelowego stanu

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi logiczny błąd w procesie

displayTransitionHiddenField

public static void displayTransitionHiddenField(java.lang.String destinationStateId)
                                         throws palio.PalioException,
                                                palio.modules.hetman.exceptions.HetmanException,
                                                palio.modules.hetman.exceptions.ProcessException

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 destinationStateName. 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.

Parameters:

destinationStateId - identyfikator docelowego stanu

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi logiczny błąd w procesie

getTransitionsForDropList

public static java.util.LinkedList<java.lang.Object[]> getTransitionsForDropList()
                                                                          throws palio.PalioException,
                                                                                 palio.modules.hetman.exceptions.HetmanException,
                                                                                 palio.modules.hetman.exceptions.ProcessException

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.

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi błąd związany z definicją procesu

getTransitionsForDropList

public static java.util.LinkedList<java.lang.Object[]> getTransitionsForDropList(java.lang.String groupName,
                                                                                 java.lang.Boolean checkPossibility)
                                                                          throws palio.PalioException,
                                                                                 palio.modules.hetman.exceptions.HetmanException,
                                                                                 palio.modules.hetman.exceptions.ProcessException

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.

Parameters:

groupName - nazwa grupy przejść. jeżeli null to pobrane zostaną wszystkie możliwe przejścia z danego stanu

checkPossibility - czy sprawdzać możliwość wykonania danego przejścia (sprawdzane są uprawnienia oraz wywoływany jest obiekt warunku)

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi błąd związany z definicją procesu

isTransitionPossible

public static java.lang.Boolean isTransitionPossible(java.lang.String destinationStateId)
                                              throws palio.modules.hetman.exceptions.HetmanException,
                                                     palio.PalioException,
                                                     palio.modules.hetman.exceptions.ProcessException

Sprawdza czy jest możliwość wykonania przejścia do określonego stanu w wykonywnym kontekscie procesu (w obecnym stanie)

Parameters:

destinationStateId - identyfikator docelowego stanu

Returns:

true if transition is possible otherwise false

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi błąd związany z definicją procesu

getStateParamValue

public java.lang.Object getStateParamValue(java.lang.String processName,
                                           java.lang.String stateId,
                                           java.lang.String paramName)
                                    throws palio.modules.hetman.exceptions.ProcessException,
                                           palio.modules.hetman.exceptions.HetmanException,
                                           palio.PalioException

Zwraca wartość predefiniowanego parametru stanu

Parameters:

processName - nazwa procesu

stateId - identyfikator stanu

paramName - nazwa parametru

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi logiczny błąd w procesie

Since:

jPALIO 6.8.10, module 2.0.3

getTransitionParamValue

public java.lang.Object getTransitionParamValue(java.lang.String processName,
                                                java.lang.String sourceStateId,
                                                java.lang.String destinationStateId,
                                                java.lang.String paramName)
                                         throws palio.modules.hetman.exceptions.ProcessException,
                                                palio.modules.hetman.exceptions.HetmanException,
                                                palio.PalioException

Zwraca wartość predefiniowanego parametru przejścia

Parameters:

processName - nazwa procesu

sourceStateId - identyfikator stanu źródłowego

destinationStateId - identyfikator stanu docelowego

paramName - nazwa parametru

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi logiczny błąd w procesie

Since:

jPALIO 6.8.10, module 2.0.3

setAutoTransition

public static void setAutoTransition(java.lang.String destinationStateId)
                              throws palio.modules.hetman.exceptions.HetmanException,
                                     palio.modules.hetman.exceptions.ProcessException

Ustawia przejście jakie ma zostać automatycznie wykonane po wykonaniu aktualnego przejścia. Metoda powinna być wykonywana tylko w obiektach akcji.

Parameters:

destinationStateId - identyfikator docelowego stanu

Throws:

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi logiczny błąd w procesie

isSubprocessFinished

public java.lang.Boolean isSubprocessFinished(java.lang.String processName,
                                              java.lang.Long instanceId,
                                              java.lang.String subprocessName)
                                       throws palio.PalioException,
                                              palio.modules.hetman.exceptions.ProcessException,
                                              palio.modules.hetman.exceptions.HetmanException

Sprawdza czy dla procesowanej instancji skończył się podproces o podanej nazwie. Aby korzystać z podprocesów należy w definicji procesu zdefiniować przynajmniej jeden podproces

Parameters:

processName - nazwa procesu

instanceId - identyfikator procesowanej instancji

subprocessName - nazwa podprocesu

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi logiczny błąd w procesie

Since:

jPALIO 6.9.1, module 2.5.0

isSubprocessFinishedSuccessfully

public java.lang.Boolean isSubprocessFinishedSuccessfully(java.lang.String processName,
                                                          java.lang.Long instanceId,
                                                          java.lang.String subprocessName)
                                                   throws palio.PalioException,
                                                          palio.modules.hetman.exceptions.ProcessException,
                                                          palio.modules.hetman.exceptions.HetmanException

Sprawdza czy dla procesowanej instancji skończył się z powodzeniem podproces o podanej nazwie. Aby korzystać z podprocesów należy w definicji procesu zdefiniować przynajmniej jeden podproces

Parameters:

processName - nazwa procesu

instanceId - identyfikator procesowanej instancji

subprocessName - nazwa podprocesu

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi logiczny błąd w procesie

Since:

jPALIO 6.9.1, module 2.5.0

getSourceStates

public java.util.ArrayList<java.lang.String> getSourceStates(java.lang.String processName,
                                                             java.lang.String destinationStateId)
                                                      throws palio.modules.hetman.exceptions.ProcessException,
                                                             palio.modules.hetman.exceptions.HetmanException,
                                                             palio.PalioException

Zwraca listę identyfikatorów stanów z jakich można wykonać przejście do określonego stanu.

Parameters:

processName - nazwa procesu

destinationStateId - identyfikator stanu docelowego

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi logiczny błąd w procesie

Since:

jPALIO 6.8.4, module 2.0.1

getSourceStates

public java.util.ArrayList<java.lang.String> getSourceStates(java.lang.String processName,
                                                             java.lang.Object[] destinationStatesIds)
                                                      throws palio.modules.hetman.exceptions.ProcessException,
                                                             palio.modules.hetman.exceptions.HetmanException,
                                                             palio.PalioException

Zwraca listę identyfikatorów stanów z jakich można wykonać przejście do określonych stanów.

Parameters:

processName - nazwa procesu

destinationStatesIds - tablica identyfikatorów stanów docelowych

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi logiczny błąd w procesie

Since:

jPALIO 6.8.8, module 2.0.2

getSubprocessStates

public java.util.ArrayList<java.lang.String> getSubprocessStates(java.lang.String processName,
                                                                 java.lang.String subprocessName,
                                                                 java.lang.Boolean includeLastNoSuccessStates)
                                                          throws palio.modules.hetman.exceptions.ProcessException,
                                                                 palio.modules.hetman.exceptions.HetmanException,
                                                                 palio.PalioException

Zwraca listę identyfikatorów stanów wchodzących w skład podprocesu o podanej nazwie

Parameters:

processName - nazwa procesu

subprocessName - nazwa podprocesu

includeLastNoSuccessStates - flaga określająca czy ostatnie stany podprocesu z atrybutem success ustawionym na false mają zostać dołączone do zwracanej listy

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi logiczny błąd w procesie

getStatesBefore

public java.util.ArrayList<java.lang.String> getStatesBefore(java.lang.String processName,
                                                             java.lang.String refStateId,
                                                             java.lang.Boolean includeRefState)
                                                      throws palio.modules.hetman.exceptions.ProcessException,
                                                             palio.modules.hetman.exceptions.HetmanException,
                                                             palio.PalioException

Zwraca listę identyfikatorów wszystkich stanów jakie mogą wystąpić przed stanem o podanej nazwie. Lista budowana jest na podstawie definicji procesu.

Parameters:

processName - nazwa procesu

refStateId - identyfikator stanu odniesienia

includeRefState - flaga określająca czy do zwracanej listy ma zostać dołączony stan odniesienia

Throws:

palio.PalioException - w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio

palio.modules.hetman.exceptions.HetmanException - w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman

palio.modules.hetman.exceptions.ProcessException - w przypadku gdy wystąpi logiczny błąd w procesie

Since:

jPALIO 6.9.1, module 2.5.2

getStatesAfter

public java.util.ArrayList<java.lang.String> getStatesAfter(java.lang.String processName,
                                                            java.lang.String refStateId,
                                                            java.lang.Boolean includeRefState)
                                                     throws palio.modules.hetman.exceptions.ProcessException,
                                                            palio.modules.hetman.exceptions.HetmanException,
                                                            palio.PalioException

Zwraca listę identyfikatorów wszystkich stanów jakie mogą wystąpić po stanie o podanej nazwie. Lista budowana jest na podstawie definicji procesu.

Parameters:

processName - nazwa procesu

refStateId - identyfikator stanu odniesienia

includeRefState - flaga określająca czy do zwracanej listy ma zostać dołączony stan odniesienia

Throws:

palio.modules.hetman.exceptions.ProcessException

palio.modules.hetman.exceptions.HetmanException

palio.PalioException

Since:

jPALIO 6.9.1, module 2.5.2

getManager

public palio.modules.hetman.HetmanManager getManager()

Zwraca menadżera modułu Hetman.

createProcessExecutionContext

public void createProcessExecutionContext(java.lang.String processName,
                                          java.lang.Object instanceId,
                                          java.util.Map<java.lang.String,java.lang.Object> contextParams)
                                   throws palio.modules.hetman.exceptions.HetmanException,
                                          palio.modules.hetman.exceptions.ProcessException,
                                          palio.PalioException

Tworzy "sztuczny" kontekst wykonywania procesu

Parameters:

processName - nazwa procesu

instanceId - identyfikator procesowanej instancji

contextParams - parametry kontekstu

Throws:

palio.modules.hetman.exceptions.HetmanException

palio.modules.hetman.exceptions.ProcessException

palio.PalioException

Since:

jPALIO 6.10.9, module 3.0.0