show procedure

Related topics

Contained in package wwerr_api_error_ui.

Call this procedure to display the error stack in the output format requested: HTML, XML, or TEXT. The output format is specified by one of the error content constants.

This procedure should be called by functions that are explicitly handling the exception and producing a UI from it.

Note: By default, the HTML error UI contains a Back button to navigate to the previous page. If any of the p_text_n arguments are not null, they are displayed instead of the Back button. This allows for customized error dialogs.

procedure show

(

p_output_format in integer,

p_help_url in varchar2 default null,

p_text1 in varchar2 default null,

p_url1 in varchar2 default null,

p_text2 in varchar2 default null,

p_url2 in varchar2 default null,

p_text3 in varchar2 default null,

p_url3 in varchar2 default null

);

Version: Oracle Portal 3.0.6.6.5 or later

Parameters:

p_output_format

The output format for the error stack. Acceptable values are:

CONTENT_TYPE_HTML constant integer := 1;

CONTENT_TYPE_XML constant integer := 2;

CONTENT_TYPE_TEXT constant integer := 3;

Datatype: in integer

p_help_url

A string URL for the Help page, if one is available.

Note: A null value indicates that no Help page is available and no Help icon is displayed.

Datatype: varchar2
Default: null

p_text1

A text string to print next to the first URL.

Datatype: in varchar2
Default: null

p_url1

The URL referred to in p_text1.

Datatype: in varchar2
Default: null

p_text2

A string to print next to the second URL.

Datatype: in varchar2
Default: null

p_url2

The URL referred to in p_text2.

Datatype: in varchar2
Default: null

p_text3

A string to print next to the third URL.

Datatype: in varchar2
Default: null

p_url3

The URL referred to in p_text3.

Datatype: in varchar2
Default: null

Exceptions:

If the output format specified is not a valid value, a VALUE_ERROR_EXCEPTION is raised.

Example:

In this example, the format requested is XML, two URLs with accompanying text are provided, and the parameters p_text3 and p_url3 are null.

wwerr_api_error_ui.show

(

p_output_format => 2,

p_text1 => "Help for this page",

p_url1 => http://iPortal.us.oracle.com:1500/30413_HELP/30413_HELP.page,

p_text2 => "Start Over.",

p_url2 => http://iPortal.us.oracle.com:1500/30785_DESIGN/30785_DESIGN.home,

);

Version: Oracle Portal 3.0.6.6.5 or later
Parameters:
p_output_format	The output format for the error stack. Acceptable values are: CONTENT_TYPE_HTML constant integer := 1; CONTENT_TYPE_XML constant integer := 2; CONTENT_TYPE_TEXT constant integer := 3; Datatype: in integer
p_help_url	A string URL for the Help page, if one is available. Note: A null value indicates that no Help page is available and no Help icon is displayed. Datatype: varchar2 Default: null
p_text1	A text string to print next to the first URL. Datatype: in varchar2 Default: null
p_url1	The URL referred to in p_text1. Datatype: in varchar2 Default: null
p_text2	A string to print next to the second URL. Datatype: in varchar2 Default: null
p_url2	The URL referred to in p_text2. Datatype: in varchar2 Default: null
p_text3	A string to print next to the third URL. Datatype: in varchar2 Default: null
p_url3	The URL referred to in p_text3. Datatype: in varchar2 Default: null
Exceptions: If the output format specified is not a valid value, a VALUE_ERROR_EXCEPTION is raised. Example: In this example, the format requested is XML, two URLs with accompanying text are provided, and the parameters p_text3 and p_url3 are null. wwerr_api_error_ui.show ( p_output_format => 2, p_text1 => "Help for this page", p_url1 => http://iPortal.us.oracle.com:1500/30413_HELP/30413_HELP.page, p_text2 => "Start Over.", p_url2 => http://iPortal.us.oracle.com:1500/30785_DESIGN/30785_DESIGN.home, );

Related topics
Error API package	PDK PL/SQL API Reference - Home