Previous	Next		Contents	Index	Glossary

procedure AbortProcess

    (itemtype in varchar2,

     itemkey in varchar2,

     process in varchar2 default '',

     result in varchar2 default eng_force);

Java Syntax

public static boolean abortProcess

    (WFContext wCtx,

     String itemType,

     String itemKey,

     String process,

     String result)

Description

Aborts process execution and cancels outstanding notifications. The process status is considered COMPLETE, with a result specified by the result argument. Also, any outstanding notifications or subprocesses are set to a status of COMPLETE with a result of force, regardless of the result argument.

This API also raises the oracle.apps.wf.engine.abort event. Although Oracle Workflow does not include any predefined subscriptions to this event, you can optionally define your own subscriptions to this event if you want to perform custom processing when it occurs. See: Workflow Engine Events, Oracle Workflow Developer's Guide and To Define an Event Subscription (for standalone Oracle Workflow), Oracle Workflow Developer's Guide or To Create or Update an Event Subscription (for Oracle Applications), Oracle Workflow Developer's Guide.

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 type. 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 aborted. This argument defaults to null.
result	A status assigned to the aborted process. The result must be one of the values defined in the process Result Type, or one of the following standard engine values:
	eng_exception
	eng_timeout
	eng_force
	eng_mail
	eng_null
	This argument defaults to "eng_force".

Example

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

// abort process, should see status COMPLETE with result 

// code force

System.out.println("Abort Process ..." + iType + "/" + 

    iKey);

if (!WFEngineAPI.abortProcess(ctx, iType, iKey, pr, null))

{

  System.out.println("Seemed to have problem aborting...");

  WFEngineAPI.showError(ctx);

}