|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectpalio.modules.core.Module
palio.modules.Hetman
public class Hetman
Moduł Hetman wspiera tworzenie, implementację procesów (workflow).
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(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. |
Result |
executeTransition(java.lang.String processName,
java.lang.Object instanceId,
java.lang.String destinationStateId)
|
Result |
executeTransition(java.lang.String processName,
java.lang.Object instanceId,
java.lang.String destinationStateId,
java.lang.Boolean createOwnTransaction)
|
Result |
executeTransition(java.lang.String processName,
java.lang.Object instanceId,
java.lang.String destinationStateId,
java.util.Map<java.lang.String,java.lang.Object> contextParams)
|
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(?) |
HetmanManager |
getManager()
Zwraca menadżera modułu Hetman. |
static 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 Result |
newResult(java.lang.Boolean success)
Funkcja tworzy obiekt typu Result używany w obiektach Action i Condition. |
static Result |
newResult(java.lang.Boolean success,
java.lang.String message)
Funkcja tworzy obiekt typu Result używany w obiektach Action i Condition. |
static 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 |
---|
public static final java.lang.String MESSAGE_CSS_CLASS
public static final java.lang.String ERROR_MESSAGE_CSS_CLASS
public static final java.lang.String TRANSITION_BUTTON_CSS_CLASS
Constructor Detail |
---|
public Hetman(Instance instance, java.util.Properties parameters) throws palio.PalioException
palio.PalioException
Method Detail |
---|
public java.lang.String getVersion()
Module
getVersion
in class Module
public void executeProcess(java.lang.String processName, java.lang.Object instanceId, java.util.Map<java.lang.String,java.lang.Object> contextParams) throws palio.PalioException, HetmanException, ProcessException
processName
- nazwa procesuinstanceId
- identyfikator procesowanej instancjicontextParams
- parametry kontekstu wykonywania procesu
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
public void executeProcess(java.lang.String processName, java.lang.Object instanceId) throws palio.PalioException, HetmanException, ProcessException
processName
- nazwa procesuinstanceId
- identyfikator procesowanej instancji
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
public void createProcessTemplate(java.lang.String xml) throws HetmanException, palio.PalioException
xml
- definicja procesu
HetmanException
palio.PalioException
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
processName
- nazwa procesuprocessPrefix
- prefix obiektów procesuprocessManager
- nazwa klasy menadżera procesuinputXml
- definicja w formacie UML
palio.PalioException
public Result executeTransition(java.lang.String processName, java.lang.Object instanceId, java.lang.String destinationStateId) throws palio.PalioException, HetmanException, ProcessException, BussinessException
palio.PalioException
HetmanException
ProcessException
BussinessException
public Result executeTransition(java.lang.String processName, java.lang.Object instanceId, java.lang.String destinationStateId, java.lang.Boolean createOwnTransaction) throws palio.PalioException, HetmanException, ProcessException, BussinessException
palio.PalioException
HetmanException
ProcessException
BussinessException
public 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, HetmanException, ProcessException, BussinessException
palio.PalioException
HetmanException
ProcessException
BussinessException
public 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, HetmanException, ProcessException, BussinessException
processName
- nazwa procesuinstanceId
- identyfikator procesowanej instancjidestinationStateId
- identyfikator docelowego stanucontextParams
- parametry konteksktu wykonywania procesucreateOwnTransaction
- 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
palio.PalioException
HetmanException
ProcessException
BussinessException
public static Result newResult(java.lang.Boolean success)
public static Result newResult(java.lang.Boolean success, java.lang.String message)
public static Result newResult(java.lang.Boolean success, java.lang.String message, java.lang.String errorMessage)
public static ProcessExecutionContext getProcessExecutionContext() throws HetmanException
HetmanException
public static java.lang.Object getProcessExecutionContextParam(java.lang.String name) throws HetmanException
name
- nazwa procesu
HetmanException
- w przypadku gdy wystąpiła próba pobrania parametru, wówczas gdy nie został ustawiony konkekst wykonywania
procesupublic static void displayTransitions() throws palio.PalioException, HetmanException
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetmanpublic static void displayProcess() throws HetmanException, palio.PalioException
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
palio.PalioException
displayTransitions()
public static void displayTransitionButtonName(java.lang.String destinationStateId)
destinationStateId
- identyfikator docelowego stanupublic static void displayTransitionButton(java.lang.String destinationStateId, java.lang.String label, java.lang.String cssClass) throws palio.PalioException, HetmanException, ProcessException
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_label
w definicji przejścia.
destinationStateId
- identyfikator docelowego stanulabel
- labelka wyświetlana na przyciskucssClass
- klasa CSS przycisku
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi logiczny błąd w procesiepublic static void displayTransitionButton(java.lang.String destinationStateId, java.lang.String cssClass) throws palio.PalioException, HetmanException, ProcessException
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_label
w definicji przejścia.
destinationStateId
- identyfikator docelowego stanucssClass
- klasa CSS przycisku
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi logiczny błąd w procesiepublic static void displayTransitionButton(java.lang.String destinationStateId) throws palio.PalioException, HetmanException, ProcessException
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_label
w definicji przejścia.
destinationStateId
- identyfikator docelowego stanu
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi logiczny błąd w procesiepublic static void displayTransitionHiddenField(java.lang.String destinationStateId) throws palio.PalioException, HetmanException, ProcessException
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.
destinationStateId
- identyfikator docelowego stanu
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi logiczny błąd w procesiepublic static java.util.LinkedList<java.lang.Object[]> getTransitionsForDropList() throws palio.PalioException, HetmanException, ProcessException
label
.
w definicji przejścia. Lista rozwijana musi mieć nazwę HTransition.
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi błąd związany z definicją procesupublic static java.util.LinkedList<java.lang.Object[]> getTransitionsForDropList(java.lang.String groupName, java.lang.Boolean checkPossibility) throws palio.PalioException, HetmanException, ProcessException
label
w
definicji przejścia. Lista rozwijana musi mieć nazwę HTransition.
groupName
- nazwa grupy przejść. jeżeli null to pobrane zostaną wszystkie możliwe przejścia z danego stanucheckPossibility
- czy sprawdzać możliwość wykonania danego przejścia (sprawdzane są uprawnienia oraz wywoływany jest obiekt
warunku)
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi błąd związany z definicją procesupublic static java.lang.Boolean isTransitionPossible(java.lang.String destinationStateId) throws HetmanException, palio.PalioException, ProcessException
destinationStateId
- identyfikator docelowego stanu
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi błąd związany z definicją procesupublic java.lang.Object getStateParamValue(java.lang.String processName, java.lang.String stateId, java.lang.String paramName) throws ProcessException, HetmanException, palio.PalioException
processName
- nazwa procesustateId
- identyfikator stanuparamName
- nazwa parametru
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi logiczny błąd w procesiepublic java.lang.Object getTransitionParamValue(java.lang.String processName, java.lang.String sourceStateId, java.lang.String destinationStateId, java.lang.String paramName) throws ProcessException, HetmanException, palio.PalioException
processName
- nazwa procesusourceStateId
- identyfikator stanu źródłowegodestinationStateId
- identyfikator stanu docelowegoparamName
- nazwa parametru
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi logiczny błąd w procesiepublic static void setAutoTransition(java.lang.String destinationStateId) throws HetmanException, ProcessException
destinationStateId
- identyfikator docelowego stanu
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi logiczny błąd w procesiepublic java.lang.Boolean isSubprocessFinished(java.lang.String processName, java.lang.Long instanceId, java.lang.String subprocessName) throws palio.PalioException, ProcessException, HetmanException
processName
- nazwa procesuinstanceId
- identyfikator procesowanej instancjisubprocessName
- nazwa podprocesu
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi logiczny błąd w procesiepublic java.lang.Boolean isSubprocessFinishedSuccessfully(java.lang.String processName, java.lang.Long instanceId, java.lang.String subprocessName) throws palio.PalioException, ProcessException, HetmanException
processName
- nazwa procesuinstanceId
- identyfikator procesowanej instancjisubprocessName
- nazwa podprocesu
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi logiczny błąd w procesiepublic java.util.ArrayList<java.lang.String> getSourceStates(java.lang.String processName, java.lang.String destinationStateId) throws ProcessException, HetmanException, palio.PalioException
processName
- nazwa procesudestinationStateId
- identyfikator stanu docelowego
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi logiczny błąd w procesiepublic java.util.ArrayList<java.lang.String> getSourceStates(java.lang.String processName, java.lang.Object[] destinationStatesIds) throws ProcessException, HetmanException, palio.PalioException
processName
- nazwa procesudestinationStatesIds
- tablica identyfikatorów stanów docelowych
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi logiczny błąd w procesiepublic java.util.ArrayList<java.lang.String> getSubprocessStates(java.lang.String processName, java.lang.String subprocessName, java.lang.Boolean includeLastNoSuccessStates) throws ProcessException, HetmanException, palio.PalioException
processName
- nazwa procesusubprocessName
- nazwa podprocesuincludeLastNoSuccessStates
- flaga określająca czy ostatnie stany podprocesu z atrybutem success ustawionym na false mają zostać
dołączone do zwracanej listy
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi logiczny błąd w procesiepublic java.util.ArrayList<java.lang.String> getStatesBefore(java.lang.String processName, java.lang.String refStateId, java.lang.Boolean includeRefState) throws ProcessException, HetmanException, palio.PalioException
processName
- nazwa procesurefStateId
- identyfikator stanu odniesieniaincludeRefState
- flaga określająca czy do zwracanej listy ma zostać dołączony stan odniesienia
palio.PalioException
- w przypadku gdy wystąpi błąd związanych dowolnym mechanizmem jPalio
HetmanException
- w przypadku gdy wystąpi błąd w funkcjonalności związanej bezpośrednio z modułem Hetman
ProcessException
- w przypadku gdy wystąpi logiczny błąd w procesiepublic java.util.ArrayList<java.lang.String> getStatesAfter(java.lang.String processName, java.lang.String refStateId, java.lang.Boolean includeRefState) throws ProcessException, HetmanException, palio.PalioException
processName
- nazwa procesurefStateId
- identyfikator stanu odniesieniaincludeRefState
- flaga określająca czy do zwracanej listy ma zostać dołączony stan odniesienia
ProcessException
HetmanException
palio.PalioException
public HetmanManager getManager()
public void createProcessExecutionContext(java.lang.String processName, java.lang.Object instanceId, java.util.Map<java.lang.String,java.lang.Object> contextParams) throws HetmanException, ProcessException, palio.PalioException
processName
- nazwa procesuinstanceId
- identyfikator procesowanej instancjicontextParams
- parametry kontekstu
HetmanException
ProcessException
palio.PalioException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |