LongRunningProcessHelper (webclient 8.6.0-8 API)

java.lang.Object
- com.saperion.ngc.servlet.process.LongRunningProcessHelper

public final class LongRunningProcessHelper
extends java.lang.Object

Helper class used to start and control long running processes.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`finishProcess()`	Marks the current process as finished.
`LRPControlBean`	`getControlBean()`
`static LongRunningProcessHelper`	`getForSession()`
`static LongRunningProcessHelper`	`getForSession(javax.servlet.http.HttpSession session)`
`void`	`startProcess(LRPControlBean controlBean)`	Starts the process as configured in the provided control bean.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getForSession
```
public static LongRunningProcessHelper getForSession()
```
    Returns:
    
    the LongRunningProcessHelper for the current session.
  - getForSession
```
public static LongRunningProcessHelper getForSession(javax.servlet.http.HttpSession session)
```
    Parameters:
    
    session - the current session
    
    Returns:
    
    the LongRunningProcessHelper for the current session
  - startProcess
```
public void startProcess(LRPControlBean controlBean)
                  throws ProcessAlreadyRunningException
```
    Starts the process as configured in the provided control bean.
    
    Parameters:
    
    controlBean - control bean
    
    Throws:
    
    ProcessAlreadyRunningException - thrown when another process is already running in this session
  - getControlBean
```
public LRPControlBean getControlBean()
```
    Returns:
    
    the control bean for the process currently running in this session
  - finishProcess
```
public void finishProcess()
```
    Marks the current process as finished.