UESProcess

```
@UESComponent
@EnableScriptAPI
public interface UESProcess
```
UESProcess component allows access to process associated with current use case. Its purpose is to offer methods for reporting progress and for synchronization with other processes launched from current use case.

Since:

UES7-02

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`completed(UESMessage message)` Method marks use case as completed.
`void`	`completedFinal(UESMessage message)` Method marks use case as finished.
`void`	`completedWithError(UESMessage message, java.lang.Exception exception)` Method marks use case as failed.
`void`	`completedWithWarning(UESMessage message, java.lang.Exception exception)` Method marks use case as completed with warnings.
`void`	`fireActiveEvent(UESProcessEvent processEvent)` Method is used for invocation of general active process event (alternative to using methods info, warning and progress).
`void`	`fireCompletedEvent(UESProcessEvent processEvent)` Method is used for invocation of general completed process event (alternative to using methods completed, completedWithWarning, completedWithError and completedFinal).
`UESURI`	`getCurrentProcessUri()` Returns UESURI of currently active process or null if there is no active process.
`UESProcessResult`	`getResult(long timeout, java.lang.String... eventCodes)` Method searches all subprocesses of recent use case process and returns first result matching provided event codes within given timeout.
`void`	`info(UESMessage message)` Method send info notification from use case.
`boolean`	`isProcessEventToActivityPropagationEnabled()` Method used to read configuration of propagation of process events to activity from which was process launched.
`void`	`progress(UESMessage message)` Method is used for informing user of use case progress.
`void`	`setProcessEventToActivityPropagationEnabled(boolean enabled)` Method used to configure propagation of process events to activity from which was process launched.
`void`	`start(UESMessage message, int totalSteps)` Method should be called on the beginning of use case.
`void`	`warning(UESMessage message, java.lang.Exception exception)` Method send warning notification from use case.

- Method Detail
  - setProcessEventToActivityPropagationEnabled
    
    void setProcessEventToActivityPropagationEnabled(boolean enabled)
    
    Method used to configure propagation of process events to activity from which was process launched.
    
    Parameters:
    enabled - true/false
    Since:
    
    UES7-02
  - isProcessEventToActivityPropagationEnabled
    
    boolean isProcessEventToActivityPropagationEnabled()
    
    Method used to read configuration of propagation of process events to activity from which was process launched.
    
    Returns:
    True if propagation is enabled, else false
    Since:
    
    UES7-04
  - start
    
    void start(UESMessage message,
    int totalSteps)
    
    Method should be called on the beginning of use case. It allows to set custom message to be send to user and also set total steps needed to be worked in use case. Calling of this method is optional as long as we do not want to report use case progress using progress bar dialog.
    
    Parameters:
    message - Message for user (may be null)
    totalSteps - Total steps to be done
    Since:
    
    UES7-02
  - info
    
    void info(UESMessage message)
    
    Method send info notification from use case. Unlike common messages (send by progress method) which is stored directly on recent process, notification is propagated further into other components and may trigger additional actions. Therefore notification should be used only for reporting of important milestones in use case flow.
    In case detailed reporting was enabled (totalSteps were set in start method), each call of info notification means one step.
    
    Parameters:
    message - Message for user
    Since:
    
    UES7-02
  - warning
    
    void warning(UESMessage message,
    java.lang.Exception exception)
    
    Method send warning notification from use case. Unlike common messages (send by progress method) which is stored directly on recent process, notification is propagated further into other components and may trigger additional actions. Therefore warning notification should be used only for reporting of more serious problems milestones in use case flow.
    In case detailed reporting was enabled (totalSteps were set in start method), call of warning notification has no effect (progress is not pushed further).
    
    Parameters:
    message - Message for user
    exception - Exception which caused problem (may be null)
    Since:
    
    UES7-02
  - progress
    
    void progress(UESMessage message)
    
    Method is used for informing user of use case progress. Unlike notifications, progress message is stored directly on process and is not propagated into other components.
    In case detailed reporting was enabled (totalSteps were set in start method), each call of progress method means one step.
    
    Parameters:
    message - Message for user (may be null)
    Since:
    
    UES7-02
  - fireActiveEvent
    
    void fireActiveEvent(UESProcessEvent processEvent)
    
    Method is used for invocation of general active process event (alternative to using methods info, warning and progress). Unlike other methods, general event has more options. It allows to set code of event (which may be used by other processes as synchronization point) and UESURI of related object (used to provide partial result for processes waiting for this event).
    
    Parameters:
    processEvent - UESProcessEvent DTO
    Since:
    
    UES7-02
  - completed
    
    void completed(UESMessage message)
    
    Method marks use case as completed. This state means use case is finished and activity will end in non-final sate.
    Calling of this method is optional.
    
    Parameters:
    message - Message for user (may be null)
    Since:
    
    UES7-02
  - completedWithWarning
    
    void completedWithWarning(UESMessage message,
    java.lang.Exception exception)
    
    Method marks use case as completed with warnings. This state means use case is finished but due to some internal problems it did not provide expected result but ended up in some alternative flow.
    Calling of this method is optional.
    
    Parameters:
    message - Message for user (may be null)
    exception - Instance of exception caused warning (may be null)
    Since:
    
    UES7-02
  - completedWithError
    
    void completedWithError(UESMessage message,
    java.lang.Exception exception)
    
    Method marks use case as failed. Failed state means there was some serious problem which is not covered by any alternative flow of use case.
    Calling of this method is optional. In case of exception thrown from use case, process automatically ends in failed state. This method can be uses to override default error message.
    
    Parameters:
    message - Message for user (may be null)
    exception - Instance of exception caused error (may be null)
    Since:
    
    UES7-02
  - completedFinal
    
    void completedFinal(UESMessage message)
    
    Method marks use case as finished. This state means use case is finished and activity will end in final sate. Calling of this method is optional.
    
    Parameters:
    message - Message for user (may be null)
    Since:
    
    UES7-02
  - fireCompletedEvent
    
    void fireCompletedEvent(UESProcessEvent processEvent)
    
    Method is used for invocation of general completed process event (alternative to using methods completed, completedWithWarning, completedWithError and completedFinal). Unlike other methods, general event has more options. It allows to set code of event (which may be used by other processes as synchronization point) and UESURI of related object (used to provide partial result for processes waiting for this event).
    
    Parameters:
    processEvent - UESProcessEvent DTO
    Since:
    
    UES7-02
  - getResult
    
    UESProcessResult getResult(long timeout,
    java.lang.String... eventCodes)
    
    Method searches all subprocesses of recent use case process and returns first result matching provided event codes within given timeout. In case no event codes are given, method waits until all subprocesses are finished and returns result with UESURI of related object from last finished process (result which was set in last finished subprocess, if non is present, result from previously finished subprocess, etc.)null is immediately returned.
    Method waits for result until matching event is invoked from any subprocess, timeout expires or all subprocesses are finished (meaning expected event cannot be set anymore).
    
    Parameters:
    timeout - Timeout in milliseconds (0 for maximum (8 hours) timeout, negative value for returning immediate result).
    eventCodes - List of event codes (regular expressions may be used)
    
    Returns:
    First found result matching event codes or last result from all subprocesses if event codes are not provided.
    Since:
    
    UES7-02
  - getCurrentProcessUri
    
    UESURI getCurrentProcessUri()
    
    Returns UESURI of currently active process or null if there is no active process.
    
    Returns:
    UESURI of process
    Since:
    
    UES8-08

Interface UESProcess

Method Summary

Method Detail

setProcessEventToActivityPropagationEnabled

isProcessEventToActivityPropagationEnabled

start

info

warning

progress

fireActiveEvent

completed

completedWithWarning

completedWithError

completedFinal

fireCompletedEvent

getResult

getCurrentProcessUri