com.appiancorp.suiteapi.process.test

Class ProcessController

java.lang.Object

com.appiancorp.suiteapi.process.test.Controller

com.appiancorp.suiteapi.process.test.ProcessController

Direct Known Subclasses:

TaskController

public class ProcessController
extends Controller

ProcessController provides simplified access for controlling a process.

This allows simplified access to starting and concluding a process under program control.

As this extends Controller, all Controller capabilities are available.

See Also:

TaskController

Nested Class Summary

Nested classes/interfaces inherited from class com.appiancorp.suiteapi.process.test.Controller

Controller.ControllerException, Controller.LogElement, Controller.LogLevel

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Long	targetProcessId

Fields inherited from class com.appiancorp.suiteapi.process.test.Controller

defaultDuration, defaultTimeUnit, log, LOG, logLevel, logToLogger, performance, sc

Constructor Summary

Constructors

Constructor and Description
ProcessController(ServiceContext sc, java.lang.Long targetProcessId) Construct a ProcessController for the given ServiceContext.

Method Summary

Modifier and Type	Method and Description
int	concludeProcess() Conclude process will return whenever the target process is no longer active.
int	concludeProcess(long duration, java.util.concurrent.TimeUnit timeUnit) Conclude process will return whenever the target process is no longer active.
java.lang.Long	startProcess(java.lang.Long processModelId, ProcessVariable[] pvs) Start the given ProcessModel using the given ProcessVariables.

Methods inherited from class com.appiancorp.suiteapi.process.test.Controller

clearLog, enableLogToLogger, enablePerformanceLogging, getLog, getPerformanceSummary, log, setLogLevel, setTimeout, yield

Methods inherited from class java.lang.Object

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

Field Detail

targetProcessId

protected java.lang.Long targetProcessId

Constructor Detail

ProcessController

public ProcessController(ServiceContext sc,
                         java.lang.Long targetProcessId)

Construct a ProcessController for the given ServiceContext.

Parameters:

sc -

activityId -

Method Detail

startProcess

public java.lang.Long startProcess(java.lang.Long processModelId,
                                   ProcessVariable[] pvs)
                            throws InvalidProcessModelException,
                                   PrivilegeException,
                                   InvalidStateException,
                                   StorageLimitException,
                                   InvalidUserException,
                                   java.lang.IllegalArgumentException,
                                   java.lang.Exception

Start the given ProcessModel using the given ProcessVariables.

Parameters:

processModelId -

pvs -

Returns:

processId

Throws:

java.lang.Exception

java.lang.IllegalArgumentException

InvalidUserException

StorageLimitException

InvalidStateException

PrivilegeException

InvalidProcessModelException

concludeProcess

public int concludeProcess()
                    throws InvalidProcessException,
                           ArchivedProcessException,
                           PrivilegeException,
                           java.util.concurrent.TimeoutException

Conclude process will return whenever the target process is no longer active. This may be completed, an error status, etc. -- anything other than STATE_ACTIVE. This method will timeout after this Controller's default timeout duration.

Returns:

process status; see ProcessSummary STATE_x constants

Throws:

java.util.concurrent.TimeoutException

PrivilegeException

ArchivedProcessException

InvalidProcessException

concludeProcess

public int concludeProcess(long duration,
                           java.util.concurrent.TimeUnit timeUnit)
                    throws InvalidProcessException,
                           ArchivedProcessException,
                           PrivilegeException,
                           java.util.concurrent.TimeoutException

Conclude process will return whenever the target process is no longer active. This may be completed, an error status, etc. -- anything other than STATE_ACTIVE. This method will timeout after the given timeout duration.

Parameters:

duration -

timeUnit -

Returns:

process status

Throws:

PrivilegeException

ArchivedProcessException

InvalidProcessException

java.util.concurrent.TimeoutException