show_portlet procedure

Related topics

Contained in package wwpro_api_provider.

Oracle Portal calls this method to render a portlet on a page. When called the portlet should produce the necessary HTML or XML/XSL to display itself on the Oracle Portal page. This method may be called in one of eight different modes.

The page produced should contain the restricted set of HTML markup that is legal to place inside an HTML table cell, i.e. no HEAD or BODY tags as these are applied by Oracle Portal.

Notes:

  • The provider may delegate calls to individual portlet implementations.

  • If you choose to implement multiple portlets in a single package, calls should be delegated to that package.
  • You are responsible for determining the appropriate level of security and auditing.
  • A single portlet can be placed as separate instances on many pages. Each instance is assigned its own reference path by the containing page.
  • The reference_path parameter can by used by the portlet as part of the key for storing end-user customization information.
  • More than one instance of a portlet can be displayed on the same page.

procedure show_portlet

(

p_portlet_record in out portlet_runtime_record

);

Any user can use this procedure.

Version: Oracle Portal 3.0.6.6.5 or later

Parameter:

p_portlet_
record

A portlet record structure that contains information for the requested portlet.

Datatype: in out portlet_runtime_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 does not allow the user to run it, a PROVIDER_SECURITY_EXCEPTION is raised.
  • If the provider does not reside on the local node, a PROVIDER_NOT_LOCAL_EXCEPTION is raised.
  • If the provider has given invalid information about the portlet, a PORTLET_VALIDATION_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.show_portlet

(

l_portlet_record

);

Call to the provider

example_provider.show_portlet

(

l_portlet_record

);

 Notes

  • Because the portlet_id indicates each specific portlet's page and position on the page, portlet developers can use it to implement multiple portlets with a single PL/SQL package.

  • The page rendered must contain only HTML markup appropriate for an HTML table cell. Oracle Portal applies the HTML, HEAD, and BODY tags.

Related topics

Back to top

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