get_portlet function

Related topics

Contained in package wwpro_api_provider.

Call this function to return the properties of a portlet. These are returned in a wwpro_api_provider.portlet_record structure.

Note: The provider can delegate a call to the portlet implementation to return the portlet record or directly fill in the details for the portlet record.

function get_portlet

(

p_provider_id in integer,

p_portlet_id in integer,

p_language in varchar2 default null

)

return portlet_record;

Any user can use this function.

Version: Oracle Portal 3.0.6.6.5 or later

Parameters:

p_provider_id

A unique identifier used to identify the provider.

Note: A null value is not permitted.

Datatype: in integer

p_portlet_id

A unique identifier that locates the portlet within the provider domain.

Note: A null value is not permitted.

Datatype: in integer

p_language

The native language in which provider translatable strings are returned.

Datatype: in varchar2
Default: null

Returns:

This function returns a portlet record as wwpro_api_provider.portlet_record.

Exceptions:

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

If the provider cannot be located, PROVIDER_NOT_FOUND_EXCEPTION is raised.

If the provider cannot be executed, PROVIDER_EXECUTION_EXCEPTION is raised.

If the provider has given invalid information about the portlet, PORTLET_VALIDATION_EXCEPTION is raised.

Example:

Calling code:

l_portlet_record := wwpro_api_provider.get_portlet

(

p_provider_id =>178,

p_portlet_id =>14,

p_language =>wwnls_api.AMERICAN

);

Provider call:

l_portlet_record := example_provider.get_portlet

(

p_provider_id => 178,

p_portlet_id =>14,

p_language =>wnls_api.AMERICAN

);

Version: Oracle Portal 3.0.6.6.5 or later
Parameters:
p_provider_id	A unique identifier used to identify the provider. Note: A null value is not permitted. Datatype: in integer
p_portlet_id	A unique identifier that locates the portlet within the provider domain. Note: A null value is not permitted. Datatype: in integer
p_language	The native language in which provider translatable strings are returned. Datatype: in varchar2 Default: null
Returns: This function returns a portlet record as wwpro_api_provider.portlet_record. Exceptions: If invalid information about the provider is returned, PROVIDER_VALIDATION_EXCEPTION is raised. If the provider cannot be located, PROVIDER_NOT_FOUND_EXCEPTION is raised. If the provider cannot be executed, PROVIDER_EXECUTION_EXCEPTION is raised. If the provider has given invalid information about the portlet, PORTLET_VALIDATION_EXCEPTION is raised. Example: Calling code: l_portlet_record := wwpro_api_provider.get_portlet ( p_provider_id =>178, p_portlet_id =>14, p_language =>wwnls_api.AMERICAN ); Provider call: l_portlet_record := example_provider.get_portlet ( p_provider_id => 178, p_portlet_id =>14, p_language =>wnls_api.AMERICAN );

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