describe_portlet_parameters function

Related topics

Contained in package wwpro_api_provider.

Oracle Portal calls this function when it needs to know the parameters that the portlet understands.

Note: When called, the portlet should return a list of the parameters that it understands in the table: wwpro_api_provider.portlet_parameter_table

function describe_portlet_parameters

(

p_provider in integer,

p_portlet_id in integer,

p_language in varchar2

)

return portlet_parameter_table;

Any user can use this function.

Version: Oracle Portal 3.0.6.6.5 or later

Parameters:

p_provider_id

A unique identifier for the provider.

Datatype: in integer

p_portlet_id

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

Note: A null value is not permitted.

Datatype: in integer

p_language

The identifier for the native language in which the strings are returned to Oracle Portal.

Note: A null value is not permitted.

Datatype: in varchar2

Returns:

This function returns a table that contains all the parameters that the specified portlet understands.

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:

l_parameter_list := wwpro_api_provider.describe_portlet_parameters
(

p_provider_id =>178,

p_portlet_id =>14,

p_language =>wwnls_api.AMERICAN

);

Call to the portlet:

l_parameter_list := example_provider.describe_portlet_parameters
(

p_provider_id =>178,

p_portlet_id =>14,

p_language =>wwnls_api.AMERICAN

);

Version: Oracle Portal 3.0.6.6.5 or later
Parameters:
p_provider_id	A unique identifier for the provider. Datatype: in integer
p_portlet_id	A unique identifier used to locate the portlet in the provider domain. Note: A null value is not permitted. Datatype: in integer
p_language	The identifier for the native language in which the strings are returned to Oracle Portal. Note: A null value is not permitted. Datatype: in varchar2
Returns: This function returns a table that contains all the parameters that the specified portlet understands. 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: l_parameter_list := wwpro_api_provider.describe_portlet_parameters ( p_provider_id =>178, p_portlet_id =>14, p_language =>wwnls_api.AMERICAN ); Call to the portlet: l_parameter_list := example_provider.describe_portlet_parameters ( p_provider_id =>178, p_portlet_id =>14, p_language =>wwnls_api.AMERICAN );

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