portlet_record record structure and table

Related topics

In the wwpro_api_provider API package, the portlet_record contains detailed information about a portlet.

The portlet_record structure is:

type portlet_record is record

(

id integer,

provider_id integer,

name varchar2 (30),

title varchar2 (200),

short_title varchar2(80),

description varchar2 (200),

image_url varchar2(1024), -- not used

thumbnail_image_url varchar2(1024), -- not used

help_url varchar2(1024), -- not used

timeout integer,

timeout_msg varchar2(200),

implementation_style integer, -- not used

implementation_owner varchar2(2000), -- not used

implementation_name varchar2(2000), -- not used

content_type integer,-- deprecated

api_version integer, -- not used in 3.0

has_show_edit boolean,

has_show_edit_defaults boolean,

has_show_preview boolean,

call_is_runnable boolean,

call_get_portlet boolean,

accept_content_type varchar2(2000),

has_show_link_mode boolean,

mobile_only boolean,

show_behaviour_style integer,

language varchar2(30),

preference_store_path varchar2(2000),

created_on date,

created_by varchar2(256),

last_updated_on date,

last_updated_by varchar2(256),

pass_all_url_params boolean

);

Version: Oracle Portal 3.0.6.6.5 or later

Field names and definitions

id

A unique identifier used to locate the portlet in the provider domain.

Note: A null value is not permitted.

Datatype: integer

provider_id

The ID of the provider that implements the portlet.

Datatype: integer

name

A unique identifier used to locate the portlet in the provider domain. The name should not contain any spaces.

Note: A null value is not permitted.

Datatype: varchar2

title

The title string displayed when the portlet is displayed.

Notes:

This is the same as the title returned when the list of portlets is requested.

The description returned is responsive to the language parameter used when obtaining the wwpro_api_provider.portlet_record.

A null value is not permitted.

Datatype: varchar2

short_title

A shorter version of the title (above). A maximum 80 characters is allowed. If this parameter is not set, the long title is used instead.

This field is available with Oracle9iAS Portal version 9.0.2 or later.

Datatype: varchar2

description

A short description of the portlet.

Notes:

This description is sensitive to the language parameter used when obtaining the wwpro_api_provider.portlet_record.

This description may be used when a list of portlets is requested.

A null value is not permitted.

Datatype: varchar2

image_url

This field is not used by Oracle Portal 3.0 or later.

help_url

This field is not used by Oracle Portal 3.0 or later.

thumbnail_image_url

This field is not used by Oracle Portal 3.0 or later.

timeout

The number of seconds that should be spent attempting to execute the portlet before a timeout operation occurs.

Notes:

This property is only used when the portlet is executed directly inside Oracle Portal.

A null value indicates to use the timeout value of the provider.

Datatype: integer

timeout_msg

The message string to be presented when an execution timeout occurs.

The timeout message may not contain mobile (mobileMXL) or
desktop (HTML) markup.

Note: A null value indicates that the timeout message of the provider should be used.

Datatype: varchar2

implementation_style

This field is not used by Oracle Portal 3.0 or later.

implementation_owner

This field is not used by Oracle Portal 3.0 or later.

implementation_name

This field is not used by Oracle Portal 3.0 or later.

content_type

The type of data the portlet produces, i.e. one of:

wwpro_api_provider.CONTENT_TYPE_HTML

wwpro_api_provider.CONTENT_TYPE_XML

wwpro_api_provider.CONTENT_TYPE_MOBILE.

...or a combination of the above (by adding any of the above together).

This field is now deprecated.

Datatype: integer

api_version

The version of the API to which the portlet conforms.

Note: For Oracle Portal 3.0, this value must be wwpro_api_provider.API_VERSION_1.

Datatype: integer

has_show_edit

Indicates if the portlet implements an Edit (or Customize) page.

See show_portlet procedure.

Datatype: boolean

has_show_edit_
defaults

Indicates if the portlet implements an Edit Defaults page that can be used by administrators to establish default display options for all users.

See show_portlet procedure.

Datatype: boolean

has_show_preview

Indicates if the portlet implements a Preview portlet, i.e. one that can be viewed from the Add Portlet screen and the Portlet Repository.

See show_portlet procedure.

This field is available with Oracle Portal version 3.0.9 or later.

Datatype: boolean

call_is_runnable

Indicates whether the portal must make calls to the provider's is_portlet_runnable function for the portlet.

The provider's is_portlet_runnable function is called prior to displaying a portlet in the Portlet Repository. For a public portlet this function will always return true so there is no need to contact the provider. In this case the provider should set the value for call_is_runnable to false so that the provider's is_portlet_runnable function is not called.

The default for this flag is true.

This field is available with Oracle Portal version 3.0.9 or later.

Datatype: boolean

call_get_portlet

Indicates whether the portal can use the portlet record data stored in the Portlet Metadata Repository (PMR) instead of contacting the provider for the portlet record. If the portlet record (specified by provider id, portlet id, and language) returned by a provider does not change, then the provider should set the value for call_get_portlet to false.

This tells the portal to use the PMR instead of making calls to the provider's get_portlet and get_portlet_list functions.

An example of when a provider would not want the portal to use portlet metadata from the PMR, is when the value of the portlet records is different for logged on users.

The default for this flag is true.

This field is available with Oracle Portal version 3.0.9 or later.

Datatype: boolean

accept_content_type

This is a comma delimited list of content_types whose values are the types of content that the portlet produces.

For example, if a portlet can produce both HTML and MOBILEXML the string would be: 'text/html,text/vnd.oracle.mobilexml'

This field is available with Oracle Portal version 3.0.9 or later.

Datatype: varchar2(2000)

has_show_link_mode

This portlet implements a Menu Link Label, SHOW mode method. If the value is false, the portlet title is used for the Menu Link Label.

This field is available with Oracle Portal version 3.0.9 or later.

Datatype: boolean

mobile_only

Indicates whether the portlet is available only to mobile devices.

If set to true, the portlet is only available for mobile devices, i.e. it cannot be added to standard Web pages.

If set to false (default) the portlet can be displayed on both Web pages and mobile devices (if the portlet can produce at least mobilexml).

This field is available with Oracle9iAS Portal version 9.0.2 or later.

Datatype: boolean

show_behaviour_style

Set to one of the SHOW behavior style constants. Currently,
the only one defined is EXTERNAL_PORTLET.

When set to EXTERNAL_PORTLET (1) this indicates that the mobile portlet's SHOW mode links outside of Oracle Portal, to a different location.

This can be used in mobile devices for existing OracleiAS Wireless applications that have not been fully converted to portlets. Only the LINK mode needs to be implemented, specifying the URL for the actual portlet content without going via Oracle Portal.

Although this is not recommended, it does allow current OracleiAS Wireless applications to be integrated with Oracle Portal with minimum effort.

Normally this parameter is set to 0 to indicate normal operation, i.e. that the mobile portlet has a SHOW mode.

This field is available with Oracle9iAS Portal version 9.0.2 or later.

Datatype: integer

language

The language in which the strings are returned.

Note: A null value is not permitted.

Datatype: varchar2

preference_store_path

The base preference store path where the provider has stored the portlet customization information.

Notes:

This path is used when exporting portlets.

When exporting a page, the reference path for the portlet is appended to the preference_store_path to reconstruct the preference path for portlet customizations.

If the value of this field is null, no preference store data is exported.

Datatype: varchar2

created_on

The date the record was created.

Datatype: date

created_by

The user who created the record.

Datatype: varchar2

last_updated_on

The most recent date the record was changed.

Datatype: date

last_updated_by

The user who most recently changed the record.

Datatype: varchar2

pass_all_url_params

Indicates parameter passing behavior in the portlet.

If true, the portlet passes all parameters on the URL to the portlet (as per Oracle Portal 3.0.9).

If false, the portlet is only passed parameters intended for that portlet. This is the default behavior in Oracle9iAS Portal 9.0.2 (V2 PDK-Java).

Note: The default value for database providers is true, since there is no V2 provider API.

This field is available with Oracle9iAS Portal version 9.0.2 or later.

Datatype: boolean

Portlet table:

The portlet table structure is returned after calling the portlet listing functions. It contains a table of portlet_records.

type portlet_table is table of portlet_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
Provider implementation API package	PDK PL/SQL API Reference - Home