Constants that providers can use

Related topics

The following are the constants specified in the API package wwpro_api_provider, and can be used by provider implementation methods:

Content type constants

CONTENT_TYPE_HTML

constant integer := 1;

CONTENT_TYPE_XML

constant integer := 2;

CONTENT_TYPE_MOBILE

constant integer := 4;

API version constants

API_VERSION_1

constant integer := 1;

API_VERSION

constant integer := API_VERSION_1;

Mode constants

MODE_SHOW

constant integer := 1;

Notes:

Displays the portlet's UI.

The most commonly used mode.

MODE_SHOW_ABOUT

constant integer := 2;

Notes:

Displays 'about' information which may include: portlet version number, source, and related information.
Called via an About link on the portlet title banner

MODE_SHOW_EDIT

constant integer := 3;

Notes:

Displays a page that stores and displays portlet instance-level customization settings for the current authorized user.

Called via a Customize link on the portlet title banner

MODE_SHOW_HELP

constant integer := 4;

Notes:

Displays help made available by the portlet provider.

Called via a Help link on the portlet title banner.

MODE_SHOW_EDIT_
DEFAULTS

constant integer := 5;

Notes:

Displays a page that stores and displays the default customization settings for the portlet instance.

Called via an Edit Defaults link on the portlet title banner.

MODE_SHOW_DETAILS

constant integer := 6;

Notes:

Displays the full portlet page. The portlet most likely displayed a partial view of this page.

Called via a link on the portlet title banner.

MODE_PREVIEW

constant integer := 7;

Notes:

Displays the portlet in a preview mode.

Called via the preview link in the Oracle Portal 'Add Portlet' screen.

MODE_LINK

constant integer := 8;

Notes:

Displays a link to the portlet UI. This mode is used when building the mobile menu and should contain code to render the link to the portlet UI in Oracle9iAS wireless XML using a SimpleHref tag.
The default link to use is provided by the page_url parameter.

Portlet parameter constants

PORTLET_PARM_
PARAMETER

constant varchar2 (9) := 'PARAMETER';

PORTLET_PARM_
DISPLAY

constant varchar2 (11) := 'DISPLAYITEM';

PORTLET_PARM_
DATAITEM

constant varchar2 (8) := 'DATAITEM';

Portlet datatype constants

STRING_TYPE

constant varchar2 (6) := 'STRING';

NUMBER_TYPE

constant varchar2 (6) := 'NUMBER';

INTEGER_TYPE

constant varchar2 (7) := 'INTEGER';

DATE_TYPE

constant varchar2 (4) := 'DATE';

CURRENCY_TYPE

constant varchar2 (8) := 'CURRENCY';

List constants

LIST_PORTLET

constant integer := 1;

LIST_COMPONENT

constant integer := 2;

SHOW behavior style constants

EXTERNAL_PORTLET

constant integer := 1;

Web cache invalidation constants

NO_INVALIDATION

constant integer := 0;

USE_INVALIDATION

constant integer := 1;

Note

A portlet instance is the display of a portlet on a single page. The same portlet may be displayed multiple times on the same page. Each time a portlet is added to a page, Oracle Portal generates a unique portlet instance ID that is the instance's reference path.

Related topics
Provider implementation API package	PDK PL/SQL API Reference - Home