Skip Headers

Oracle Workflow API Reference
Release 2.6.3

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

GetItemAttribute

PL/SQL Syntax

function GetItemAttrText

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

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

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

function GetItemAttrEvent
(itemtype in varchar2,
itemkey in varchar2,
name in varchar2) return wf_event_t;

Description

Returns the value of an item type attribute in a process. Use the correct function for your attribute type. All attribute types except number, date, and event use GetItemAttrText.

For GetItemAttrText(), GetItemAttrNumber(), and GetItemAttrDate(), you can specify TRUE for the ignore_notfound parameter to ignore the exception encountered if the specified item type 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 item type attribute is added to an item type, and your code needs to handle both the earlier version and the upgraded version of the item type.

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.
aname The internal name of an item type attribute, for GetItemAttrText(), GetItemAttrNumber(), and GetItemAttrDate().
name The internal name of an item type attribute, for GetItemAttrEvent().
ignore_notfound Specify TRUE or FALSE to indicate whether to ignore the exception if the specified item type attribute does not exist, for GetItemAttrText(), GetItemAttrNumber(), and GetItemAttrDate(). If you specify TRUE and the item type 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.