Previous	Next		Contents	Index	Glossary

procedure SuspendProcess

    (itemtype in varchar2,

     itemkey in varchar2,

     process in varchar2 default '');

Java Syntax

public static boolean suspendProcess

    (WFContext wCtx,

     String itemType,

     String itemKey,

     String process)

Description

Suspends process execution so that no new transitions occur. Outstanding notifications can complete by calling CompleteActivity( ), but the workflow does not transition to the next activity. Restart suspended processes by calling ResumeProcess( ).

Arguments (input)

wCtx	Workflow context information. Required for the Java method only. See: Oracle Workflow Context.
itemtype	A valid item type.
itemkey	A string generated from the application object's primary key. The string uniquely identifies the item within an item type. The item type and key together identify the process. See: CreateProcess.
process	An optional argument that allows the selection of a particular subprocess for that item. Provide the process activity's label name. If the process activity label name does not uniquely identify the subprocess you can precede the label name with the internal name of its parent process. For example, <parent_process_internal_name>:<label_name>. If this argument is null, the top level process for the item is suspended. This argument defaults to null.

Example

The following code excerpt shows an example of how to call suspendProcess() in a Java program. The example code is from the WFTest.java program.

// suspend, status should become SUSPEND

System.out.println("Suspend Process " + iType +"/"+ iKey +

    " ...");

if (WFEngineAPI.suspendProcess(ctx, iType, iKey, null))

  System.out.println("Seems to suspend successfully");

else

{

  System.out.println("suspend failed");

  WFEngineAPI.showError(ctx);

}