| nazwa funkcji | opis funkcji |
|---|---|
| addProcess | dodaje proces |
| copyProcess | kopiuje proces oraz podrzędne do niego stany, przejścia, obiekty złożone oraz uprawnienia do stanów i przejść |
| removeProcess | usuwa proces, przypisane do niego stany, przejścia oraz prawa do nich |
| lockProcess | blokuje podany proces |
| unlockProcess | odblokowuje podany proces |
| getProcessStates | zwraca tablicę id stanów dostępnych w podanym procesie |
| getProcessErrorObject | zwraca identyfikator obiektu paliowego obsługującego błędy występujące podczas realizacji procesu (id obiektu błędu) |
| getProcessIdByName | zwraca id procesu o podanej nazwie |
| getProcessIdByTextId | zwraca id procesu o podanym identyfikatorze tekstowym |
| getProcessName | zwraca nazwę procesu |
| getProcessStateObject | zwraca identyfikator obiektu paliowego realizującego odczyt i zapis stanów procesu (id obiektu stanu) |
| getProcessStatus | zwraca status podanego procesu: N proces odblokowany, L - zablokowany |
| getProcessTextId | zwraca tekstowy identyfikator procesu |
| setProcessErrorObject | ustawia identyfikator obiektu paliowego obsługującego błędy występujące podczas realizacji procesu (id obiektu błędu) |
| setProcessName | zmienia nazwę procesu na name |
| setProcessStateObject | ustawia identyfikator obiektu paliowego realizującego odczyt i zapis stanów procesu (id obiektu stanu) |
| setProcessTextId | ustawia tekstowy identyfikator procesu |
| nazwa funkcji | opis funkcji |
|---|---|
| addState | dodaje nowy stan dla podanego procesu o domyślnej nazwie "new state" i mający następny wolny numer stanu |
| copyState | kopiuje stan w ramach procesu |
| removeState | usuwa stan o podanym identyfikatorze |
| getStateTransitions | zwraca tablicę id przejść dostępnych w podanym stanie |
| getStateIdByNumber | zwraca id stanu o podanym numerze |
| getStateIdByTextId | zwraca id stanu o podanym identyfikatorze tekstowym |
| getStateInfoString | zwraca ciąg informacyjny dla stanu o podanym identyfikatorze |
| getStateInitObject | zwraca id obiektu procesu inicjalizującego stan |
| getStateInitParam | zwraca parametr obiektu procesu inicjalizującego stan o podanym identyfikatorze |
| getStateName | zwraca nazwę stanu o podanym identyfikatorze |
| getStateNumber | zwraca numer stanu o podanym identyfikatorze |
| getStatePageTitle | zwraca tytuł strony dla stanu o podanym identyfikatorze |
| getStatePositionX | zwraca pozycję x stanu na grafie stanów i przejść |
| getStatePositionY | zwraca pozycję y stanu na grafie stanów i przejść |
| getStatePresentationObject | zwraca id obiektu procesu wyświetlającego stan |
| getStatePresentationParam | zwraca parametr obiektu procesu wyświetlającego stan |
| getStateProcessId | zwraca id procesu, do którego jest przypisany stan o podanym identyfikatorze |
| getStateRoleOwnerRight | zwraca, czy podany stan i rola paliowa są skojarzone dla użytkownika będącego właścicielem instancji |
| getStateRoleRight | zwraca, czy podany stan i rola paliowa są skojarzone, a więc czy podana rola ma prawa do danego stanu |
| getStateStartingSubprocesses | zwraca tablicę numerów |
| getStateStartingSubprocessesStr | zwraca listę numerów |
| getStateStayInStateObject | zwraca id obiektu procesu wyświetlanego przy pozostaniu w stanie |
| getStateStayInStateParam | zwraca parametr obiektu procesu wyświetlanego przy pozostaniu w stanie |
| getStateTextId | zwraca identyfikator tekstowy stanu o podanym id |
| getStateWaitForSubprCondition | zwraca id obiektu procesu sprawdzającego, czy podprocesy zakończyły się |
| getStateWaitForSubprObject | zwraca id obiektu procesu wyświetlającego stan, gdy czeka się na zakończenie podprocesów |
| getStateWaitForSubprParam | zwraca parametr obiektu procesu wyświetlającego stan, gdy czeka się na zakończenie podprocesów |
| getStateWarningString | zwraca ciąg z ostrzeżeniem dla stanu o podanym identyfikatorze |
| isStateArchive | zwraca informację, czy podany stan jest stanem archiwum |
| isStateFirstInProcess | zwraca informację, czy podany stan jest pierwszym stanem procesu |
| isStateFirstInSubprocess | zwraca informację, czy podany stan jest pierwszym stanem podprocesu |
| isStateLastInProcess | zwraca informację, czy podany stan jest ostatnim stanem procesu lub podprocesu |
| isStateNotProtected | zwraca informację, czy stan nie jest chroniony |
| setStateArchive | ustawia, czy podany stan jest stanem archiwum |
| setStateFirstInProcess | ustawia, czy podany stan jest pierwszym stanem procesu |
| setStateFirstInSubprocess | ustawia, czy podany stan jest pierwszym stanem podprocesu |
| setStateInfoString | ustawia ciąg informacyjny dla stanu o podanym identyfikatorze |
| setStateInitObject | ustawia id obiektu procesu inicjalizującego stan o podanym identyfikatorze |
| setStateInitParam | ustawia parametr obiektu procesu inicjalizującego stan o podanym identyfikatorze |
| setStateLastInProcess | ustawia, czy podany stan jest ostatnim stanem procesu lub podprocesu |
| setStateName | ustawia nazwę stanu o podanym identyfikatorze |
| setStateNotProtected | ustawia ochronę dla podanego stanu |
| setStateNumber | ustawia numer stanu o podanym identyfikatorze |
| setStatePageTitle | ustawia tytuł strony dla stanu o podanym identyfikatorze |
| setStatePosition | ustawia pozycję stanu na grafie stanów i przejść |
| setStatePositionX | ustawia pozycję x stanu na grafie stanów i przejść |
| setStatePositionY | ustawia pozycję y stanu na grafie stanów i przejść |
| setStatePresentationObject | ustawia id obiektu procesu wyświetlającego stan |
| setStatePresentationParam | ustawia parametr obiektu procesu wyświetlającego stan |
| setStateProcessId | ustawia id procesu, do którego jest przypisany stan o podanym identyfikatorze |
| setStateRoleOwnerRight | ustawia powiązanie podanego stanu i roli paliowej |
| setStateRoleRight | ustawia powiązanie podanego stanu i roli paliowej |
| setStateStartingSubprocesses | ustawia tablicę numerów |
| setStateStartingSubprocessesStr | ustawia tablicę numerów |
| setStateStayInStateObject | ustawia id obiektu procesu wyświetlanego przy pozostaniu w stanie |
| setStateStayInStateParam | ustawia parametr obiektu procesu wyświetlanego przy pozostaniu w stanie |
| setStateTextId | ustawia identyfikator tekstowy stanu o podanym id |
| setStateWaitForSubprCondition | ustawia id obiektu procesu sprawdzającego, czy podprocesy zakończyły się |
| setStateWaitForSubprObject | ustawia id obiektu procesu wyświetlającego stan, gdy czeka się na zakończenie podprocesów |
| setStateWaitForSubprParam | ustawia parametr obiektu procesu wyświetlającego stan, gdy czeka się na zakończenie podprocesów |
| setStateWarningString | ustawia ciąg z ostrzeżeniem dla stanu o podanym identyfikatorze |
| nazwa funkcji | opis funkcji |
|---|---|
| addTransition | tworzy nowe przejście |
| copyTransition | kopiuje przejście o podanym id w ramach stanu |
| removeTransition | usuwa przejście o podanym id oraz wszystkie prawa do niego |
| exchangeTransitionDisplayOrder | zamienia wartość w polu określającym kolejność wyświetlania dwóch podanych przejść |
| getTransitionConditionObject | zwraca id obiektu procesu określającego, czy przejście może zostac wyświetlone |
| getTransitionDisplayOrder | zwraca numer określający kolejność wyświetlania przejść w ramach stanu dla przejścia o podanym identyfikatorze |
| getTransitionIdByName | zwraca id przejścia o podanej nazwie |
| getTransitionIdByTextId | zwraca id przejścia o podanym identyfikatorze numerycznym |
| getTransitionName | zwraca nazwę przejścia o podanym identyfikatorze |
| getTransitionNextStateId | zwraca id stanu, do którego jest prowadzi przejście o podanym identyfikatorze |
| getTransitionObjectsParam | zwraca parametr dla obiektów condition_object oraz on_transition_object przejścia o podanym identyfikatorze |
| getTransitionOnTransitionObject | zwraca id obiektu procesu obiektu wywoływanego podczas wykonywania podanego przejścia |
| getTransitionRoleOwnerRight | zwraca, czy podane przejście i rola paliowa są skojarzone dla użytkownika będącego właścicielem instancji |
| getTransitionRoleRight | zwraca, czy podane przejście i rola paliowa są skojarzone, a więc czy podana rola ma prawa do danego przejścia |
| getTransitionStateId | zwraca id stanu, do którego jest przypisane przejście o podanym identyfikatorze |
| getTransitionTextId | zwraca identyfikator tekstowy przejścia o podanym identyfikatorze numerycznym |
| isTransitionDontDisplay | zwraca informację, czy przejście jest wyświetlane przez funkcję wyświetlającą możliwe przejścia, czy nie |
| isTransitionNotProtected | zwraca informację, czy przejście nie jest chronione |
| isTransitionStayInState | zwraca informację, czy po wykonaniu podanego przejścia należy wyświetlić obiekt pozostania w stanie, czy kolejny stan |
| setTransitionConditionObject | ustawia id obiektu procesu określającego, czy przejście |
| setTransitionDisplayOrder | ustawia numer określający kolejność wyświetlania przejść w ramach stanu dla przejścia o podanym identyfikatorze |
| setTransitionDontDisplay | ustawia, czy przejście jest wyświetlane przez funkcję wyświetlającą możliwe przejścia |
| setTransitionName | ustawia nazwę przejścia o podanym identyfikatorze |
| setTransitionNextStateId | ustawia id stanu, do którego jest prowadzi przejście o podanym identyfikatorze |
| setTransitionNotProtected | ustawia ochronę dla podanego przejścia |
| setTransitionObjectsParam | ustawia parametr dla obiektów condition_object oraz on_transition_object dla przejścia o podanym identyfikatorze |
| setTransitionOnTransitionObject | ustawia id obiektu procesu obiektu wywoływanego podczas wykonywania podanego przejścia |
| setTransitionRoleOwnerRight | ustawia powiązanie podanego przejścia i roli paliowej |
| setTransitionRoleRight | ustawia powiązanie podanego przejścia i roli paliowej |
| setTransitionStateId | ustawia id stanu, do którego jest przypisane przejście o podanym identyfikatorze |
| setTransitionStayInState | ustawia, czy po wykonaniu podanego przejścia należy wyświetlić obiekt pozostania w stanie, czy kolejny stan |
| setTransitionTextId | ustawia identyfikator tekstowy przejścia o podanym identyfikatorze numerycznym |
| nazwa funkcji | opis funkcji |
|---|---|
| addObject | tworzy obiekt procesu (obiekt złożony) |
| copyObject | kopiuje obiekt procesu i jego skojarzenia z obiektami paliowymi |
| removeObject | usuwa obiekt procesu i jego skojarzenia z obiektami paliowymi |
| addObjectsAssociation | dodaje nowe skojarzenie obiektu procesu z obiektem palio |
| removeObjectsAssociation | usuwa skojarzenie obiektu procesu z obiektem palio |
| exchangeObjectsExecuteOrder | zamienia numer porządkowy |
| getObjectPalioObjects | zwraca tablicę id skojarzeń obiektu procesu i obiektów paliowych dostępnych dla podanego obiektu procesu |
| getObjectIdByName | zwraca id obiektu procesu o podanej nazwie |
| getObjectName | zwraca nazwę obiektu procesu o podanym identyfikatorze |
| getObjectProcessId | zwraca identyfikator procesu, do którego jest przypisany podany obiekt procesu |
| getObjectsExecuteOrder | zwraca numer porządkowy |
| getObjectsPalioObjectId | zwraca identyfikator obiektu paliowego dla skojarzenia obiektu procesu i obiektu paliowego o podanym id |
| getObjectsProcessObjectId | zwraca identyfikator obiektu procesu dla skojarzenia obiektu procesu i obiektu paliowego o podanym id |
| setObjectName | ustawia nazwę obiektu procesu o podanym identyfikatorze |
| setObjectProcessId | ustawia identyfikator procesu, do którego jest przypisany podany obiekt procesu |
| setObjectsExecuteOrder | ustawia numer porządkowy |
| setObjectsPalioObjectId | ustawia identyfikator obiektu procesu dla podanego skojarzenia obiektu procesu i obiektu paliowego |
| setObjectsProcessObjectId | ustawia identyfikator obiektu procesu dla podanego skojarzenia obiektu procesu i obiektu paliowego |
| nazwa funkcji | opis funkcji |
|---|---|
| clearStateRoleOwnerRight | usuwa powiązanie podanego stanu i roli paliowej |
| clearStateRoleRight | usuwa powiązanie podanego stanu i roli paliowej |
| copyStateRoleOwnerRights | kopiuje prawa właściciela pomiędzy stanami |
| copyStateRoleRights | kopiuje prawa nie właściciela pomiędzy stanami |
| removeStateRoleOwnerRights | usuwa wszystkie prawa właściciela do stanu dla wszystkich ról |
| removeStateRoleRights | usuwa wszystkie prawa nie właściciela do stanu dla wszystkich ról |
| nazwa funkcji | opis funkcji |
|---|---|
| clearTransitionRoleOwnerRight | ustawia powiązanie podanego przejścia i roli paliowej |
| clearTransitionRoleRight | usuwa powiązanie podanego przejścia i roli paliowej |
| copyTransitionRoleOwnerRights | kopiuje prawa właściciela pomiędzy przejściami |
| copyTransitionRoleRights | kopiuje prawa nie właściciela pomiędzy przejściami |
| removeTransitionRoleOwnerRights | usuwa wszystkie prawa właściciela do przejścia dla wszystkich ról |
| removeTransitionRoleRights | usuwa wszystkie prawa nie właściciela do przejścia dla wszystkich ról |
| nazwa funkcji | opis funkcji |
|---|---|
| hasRightForState | zwraca, czy dany użytkownik ma prawo do danego stanu procesu |
| hasRightForStateOwner | zwraca, czy dany użytkownik, będący właścicielem instancji, ma prawo do danego stanu procesu |
| nazwa funkcji | opis funkcji |
|---|---|
| hasRightForTransition | zwraca, czy dany użytkownik ma prawo do danego przejścia procesu |
| hasRightForTransitionOwner | zwraca, czy dany użytkownik, będący właścicielem instancji, ma prawo do danego przejścia procesu |
| nazwa funkcji | opis funkcji |
|---|---|
| executeProcess | wykonuje podaną instancję procesu wg ścieżki określonej w procesie o podanym id |
| executeTransition | wykonuje przejście o podanym text_id dla podanej instancji procesu |
| moveInstanceToState | przesuwa instancję procesu do podanego stanu przy pomocy wywołania obiektu stanu |
| nazwa funkcji | opis funkcji |
|---|---|
| isProcessExecuting | zwraca true, jeżeli proces jest właśnie wykonywany, tzn. jeżeli właśnie jest wykonywana procedura executeprocess |
| getProcessExecutingInstanceId | zwraca id instancji dla właśnie wykonywanego procesu |
| getProcessExecutingIsOwnersInstance | zwraca, czy instancja właśnie wykonywanego procesu należy do zalogowanego użytkownika, czy nie |
| getProcessExecutingProcessId | zwraca id właśnie wykonywanego procesu |
| getProcessExecutingStateId | zwraca id stanu, w którym znajduje się instancja właśnie wykonywanego procesu |
| getProcessExecutingStateNr | zwraca numer stanu, w którym znajduje się instancja właśnie wykonywanego procesu |
| getProcessExecutingTransitionId | zwraca id przejścia które wykonuje instancja bieżącego procesu |
| nazwa funkcji | opis funkcji |
|---|---|
| parseObjectParams | ustawia parametry zawarte w przekazanym ciągu na odpowiadające im wartości |
| displayHiddenFields | wyświetla pola typu hidden, które muszą zostać przeniesione przez formularz zawierający przyciski przejść |
| displayTransition | wyświetla przejście o podanym text_id, dopuszczalne w bieżącym stanie |
| displayTransitions | wyświetla dopuszczalne w bieżącym stanie przejścia - kolejno |
| displayTransitionButton | wyświetla dopuszczalne w bieżącym stanie przejście o podanym text_id, jako przycisk |
| displayTransitionsButtons | wyświetla dopuszczalne w bieżącym stanie przejścia jako zestaw przycisków - zobacz opis funkcji displaytransitionsbuttons |
| displayTransitionsOptions | wyświetla dopuszczalne w bieżącym stanie przejścia jako listę opcji - zobacz opis funkcji displaytransitionsoptions |
| nazwa funkcji | opis funkcji |
|---|---|
| createOrReplaceHtmlInterface | tworzy interfejs HTML do zarządzania strukturą procesów (dodaje odpowiednie obiekty i strony jPALIO) |
| nazwa funkcji | opis funkcji |
|---|---|
| getErrorName | podaje nazwę błędu zwróconego przez dowolną funkcję z modułu proc |
| getVersion | zwraca numer wersji modułu |