Oracle9iAS Portal Developer Kit

portlet_parameter_record record structure and table

Related topics

In the wwpro_api_provider API package, the portlet_parameter_record describes one parameter for a portlet. A table holds records that describe all the parameters for a portlet.

The portlet_parameter_record record structure is:

type portlet_parameter_record is record

(

name varchar2(30),

datatype varchar2(30) default STRING_TYPE,

usage_type varchar2(30) default PORTLET_PARM_PARAMETER,

description varchar2(200),

display_name varchar2(80),

language varchar2(30)

);

Version: Oracle Portal 3.0.6.6.5 or later

Field names and definitions

name

The portlet parameter name.

Datatype: varchar2

datatype

One of five data type constants:

  • STRING

  • NUMBER

  • INTEGER

  • CURRENCY

  • DATE

Note: Not used Oracle9iAS Portal 9.0.2 or later.

Datatype: varchar2

usage_type

An indicator for the intended use of the parameter.

  • portlet_parm_parameter

  • portlet_parm_display

  • portlet_parm_dataitem

This value is defined and used by portlet providers.

Note: Not used Oracle9iAS Portal 9.0.2 or later.

Datatype: varchar2

description

A short description for the parameter.

Datatype: varchar2

display_name

A name/title for the parameter to be displayed in the UI.

Datatype: varchar2

language

The language in which the portlet instance is called, for example, 'AMERICAN'.

Datatype: varchar2

Portlet parameter table

This table contains records that describe all the parameters of a portlet.

type portlet_parameter_table is table of portlet_parameter_record index by binary_integer;

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

Back to top

The PL/SQL API Reference is part of the Portal Developer Kit on Portal Studio