register_portlet procedure

Related topics

Contained in package wwpro_api_provider.

Oracle Portal calls this procedure to register the use of the portlet every time the portlet is placed on a page.

This procedure gives the portlet a chance to perform instance-level initialization, such as establishing defaults for end-user customization, before the portlet is displayed.

Note:The reference_path field of the p_portlet_instance parameter can be used as a key for instance level initializations.

procedure register_portlet

(

p_portlet_instance in portlet_instance_record

);

Any user can use this procedure.

Version: Oracle Portal 3.0.6.6.5 or later

Parameters:

p_portlet_instance

A record containing the properties of a portlet instance.

Datatype: in portlet_instance_record

Exceptions:

  • If invalid information about the provider is returned, a PROVIDER_VALIDATION_EXCEPTION is raised.

  • If the provider cannot be located, a PROVIDER_NOT_FOUND_EXCEPTION is raised.
  • If the provider cannot be executed, a PROVIDER_EXECUTION_EXCEPTION is raised.
  • If the provider has given invalid information about the portlet, a PORTLET_VALIDATION_EXCEPTION is raised.
  • If the portlet does not allow the user to run it, a PORTLET_SECURITY_EXCEPTION is raised.
  • If there is a generic problem with the portlet that prevents the portlet from being executed, a PORTLET_EXECUTION_EXCEPTION is raised.

Examples:

Calling code:

wwpro_api_provider.register_portlet

(

p_portlet_instance => portlet_instance_rec

);

Call to the provider:

example_provider.register_portlet

(

p_portlet_instance => portlet_instance_rec

);

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 time a portlet is added to a page, Oracle Portal generates a unique portlet instance ID that is the instance's reference path.

  • Because Oracle Portal provides every portlet instance with a unique reference path to its containing page, portlet developers can use the reference_path as part of the key for storing end-user customization information.

Related topics

Back to top

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