| portlet_runtime_record record structure

Related topics
In the wwpro_api_provider API package, the portlet_runtime_record contains details for a portlet during runtime. A portlet_runtime_record structure is passed to the show_portlet procedure of provider implementations. Notes: The provider should set the values for caching_key, caching_period, caching_level and caching_invalidation in the show_portlet procedure if caching is enabled for the portlet. For show portlet mode, i.e., when the contents of the portlets are rendered, you should use page_url to return to the page from which you came and back_page_url is unnecessary in most cases. For customize, edit, defaults, help, and about... modes, you should use page_url to redraw the customize, edit, defaults, help, or about... pages and back_page_url to return to the page from which you came. The portlet_runtime_record structure is: type portlet_runtime_record is record ( portlet_id number, provider_id number, node_id number, reference_path varchar2(100), language varchar2(30) exec_mode number, back_page_url varchar2(32767), page_url varchar2(32767), refresh_url varchar2(32767), page_type varchar2(200), has_title_region boolean, has_border boolean, has_details boolean, has_edit boolean, has_help boolean, has_about boolean, has_remove boolean, has_collapse boolean, is_collapsed boolean, portlet_template varchar2(32767), caching_key varchar2(55), caching_level varchar2(30), caching_period number, caching_invalidation number );
Version: Oracle Portal 3.0.6.6.5 or later
Field names and definitions
portlet_id | A unique identifier used to locate the portlet in the provider domain. Datatype: number
provider_id | A unique identifier used to locate the provider. Datatype: number
node_id | The provider's host node ID. Datatype: number
reference_path | The unique path (portlet instance ID) used to identify a portlet instance. This path information is used to store and retrieve instance-specific information for the portlet. Datatype: varchar2
language | The language in which the portlet instance is called, for example, 'AMERICAN'. Datatype: varchar2
exec_mode | The mode in which the portlet is executed. Datatype: number
back_page_url | The URL for the calling page. The value stored in this field is used by portlets to redirect users back to the calling page. Note: The value can be null if there is no calling URL. Datatype: varchar2
page_url | The URL of the page containing the portlet instance that will receive the portlet_runtime_record. Datatype: varchar2
refresh_url | The URL for the calling page. The page is reloaded/built from the database, rather than from cache. This field is available with Oracle9iAS Portal 9.0.2 or later. Datatype: varchar2
page_type | No longer used.
has_title_region | Determines whether a header is displayed for the portlet as a link. Datatype: boolean
has_border | Determines whether a border is displayed around the portlet. Datatype: boolean
has_details | Determines whether a title is drawn as a link for the portlet. Note: The portlet eventually passes this to the header rendering routine by passing the entire portlet_runtime_record. This field is available with Oracle9iAS Portal 9.0.2 or later. Datatype: boolean
has_edit | Determines whether a Customize link is displayed for the portlet. Datatype: boolean
has_help | Determines whether a Help link is displayed for the portlet. Datatype: boolean
has_about | Determines whether an About link is displayed for the portlet. Datatype: boolean
has_remove | Determines whether a Remove icon is displayed for the portlet. This field is available with Oracle9iAS Portal 9.0.2 or later. Datatype: boolean
has_collapse | Determines whether a Collapse/Restore link is displayed for the portlet. This field is available with Oracle9iAS Portal version 9.0.2 or later. Datatype: boolean
is_collapsed | Indicates whether the portlet content is collapsed. This field is available with Oracle9iAS Portal 9.0.2 or later. Datatype: boolean
portlet_template | A string, representing the HTML to render the portlet's custom header and footer. The format is as follows: <header> #body# <footer> This field is available with Oracle9iAS Portal 9.0.2 or later. Datatype: varchar2
caching_key | A unique ID (set by the portlet) to indicate when the portlet content changes so the cache can be updated. For example, if the portlet has a version number and its content changes only between versions, then the version number could be included in the key. Note: The PL/SQL gateway uses the complete URL to determine the cache hit, therefore the caching key should not contain any values contained in the URL as part of its argument. Datatype: varchar2
caching_level | Indicates the level of caching that the portlet implements: SYSTEM or USER. It is set by the portlet and used for both caching by key and expiration based caching. Notes: With system-level caching, the gateway checks only the URL and the language setting for a cache hit. With user-level caching, the gateway checks the URL, language, and user ID for a cache hit. Datatype: varchar2
caching_ period | The time in minutes before the cache expires. The value zero (0) indicates that the portlet should never be cached. Note: If caching_period is specified, caching_key is ignored. Datatype: number
caching_invalidation | Determine whether Web cache is used for invalidation. This field is available with Oracle9iAS Portal 9.0.2 or later. Datatype: number

Notes
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 occurrence of a portlet on both the same and different pages is an instance of the portlet and has its own instance ID, which is the instance's reference path. A cache is specialized fast memory that holds information about a visited portlet. When a user revisits a cached portlet, the cache is checked to see if the portlet content has changed. If it has not (a cache hit), then the portlet is rapidly displayed from the cache. If it has (a cache miss), then the portlet is displayed from the more recent but slower main memory and its new content is saved in the cache.

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

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