GetText (Oracle Workflow API Reference)

Oracle Workflow API Reference
Release 2.6.3
Part Number B10286-02


	Previous	Next		Contents	Index	Glossary

GetText

PL/SQL Syntax

function GetText

(some_text in varchar2,
   nid in number,
   disptype in varchar2 default '')
  return varchar2;

Java Syntax

public static String getText

(WFContext wCtx,
     String someText,
     BigDecimal nid,
     String dispType)

Description

Substitutes tokens in an arbitrary text string using token values from a particular notification. This function may return up to 32K characters. You cannot use this function in a view definition or in an Oracle Forms Developer form. For views and forms, use GetShortText( ) which truncates values at 1950 characters.

If an error is detected, this function returns some_text unsubstituted rather than raise exceptions.

Arguments (input)

wCtx	Workflow context information. Required for the Java method only. See: Oracle Workflow Context.
some_text or someText	Text to be substituted.
nid	Notification ID of notification to use for token values.
disptype or dispType	The display type of the message body that you are token substituting the text into. Valid display types are:

wf_notification.doc_text, which returns text/plain

wf_notification.doc_html, which returns text/html

wf_notification.doc_attach, which returns null

The default is null.


	Previous	Next		Contents	Index	Glossary