Skip Headers

Oracle Workflow API Reference
Release 2.6.3

Part Number B10286-02
Previous Next       Contents Index Glossary
         Previous  Next          Contents  Index  Glossary

GetActivityAttribute

PL/SQL Syntax

function GetActivityAttrText

(itemtype in varchar2,
itemkey in varchar2,
actid in number,
aname in varchar2,
ignore_notfound in boolean default FALSE)
return varchar2;

function GetActivityAttrNumber
(itemtype in varchar2,
itemkey in varchar2,
actid in number,
aname in varchar2,
ignore_notfound in boolean default FALSE)
return number;

function GetActivityAttrDate
(itemtype in varchar2,
itemkey in varchar2,
actid in number,
aname in varchar2,
ignore_notfound in boolean default FALSE) return date;

function GetActivityAttrEvent
(itemtype in varchar2,
itemkey in varchar2,
actid in number,
name in varchar2) return wf_event_t;

Description

Returns the value of an activity attribute in a process. Use the correct function for your attribute type. If the attribute is a Number or Date type, then the appropriate function translates the number/date value to a text-string representation using the attribute format.

Note: Use GetActivityAttrText() for Form, URLs, lookups and document attribute types.

For GetActivityAttrText(), GetActivityAttrNumber(), and GetActivityAttrDate(), you can specify TRUE for the ignore_notfound parameter to ignore the exception encountered if the specified activity attribute does not exist. In this case the function returns a null value but does not raise an exception. For example, you can use this parameter if a new activity attribute is added to an activity, and your code needs to handle both the earlier version and the upgraded version of the activity.

Arguments (input)

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.
Note: Pass #SYNCH as the itemkey to create a forced synchronous process. See: Synchronous, Asynchronous, and Forced Synchronous Processes.
actid The activity ID for a particular usage of an activity in a process definition. Also referred to as the activity ID of the node.
aname The internal name of an activity attribute, for GetActivityAttrText(), GetActivityAttrNumber(), and GetActivityAttrDate().
name The internal name of an activity attribute, for GetActivityAttrEvent().
ignore_notfound Specify TRUE or FALSE to indicate whether to ignore the exception if the specified activity attribute does not exist, for GetActivityAttrText(), GetActivityAttrNumber(), and GetActivityAttrDate(). If you specify TRUE and the activity attribute you specify does not exist, the function returns a null value but does not raise an exception. Defaults to FALSE.

See Also

Event Message Structure
         Previous  Next          Contents  Index  Glossary


Oracle Logo
Copyright © 2003 Oracle Corporation.

All rights reserved.