describe_portlet_parameters function

Related topics

Contained in package wwa_app_module.

Call this function to return a table of portlet parameters for a form component.

function describe_portlet_parameters
(
p_provider_id in integer,
p_portlet_id in integer,
p_language in varchar2
)
return wwpro_api_provider.portlet_parameter_table;

Version: Oracle Portal 3.0.9

Parameters:

p_provider_id

The ID of the provider through which the form component is accessed as a portlet.

Datatype: integer

p_portlet_id

The module ID of the form component.

Datatype: integer

p_language

The language setting of the Portal. This can be accessed via <portal_schema>.wwctx_api.get_nls_language

Datatype:varchar2

Return:

This function returns a table of public portlet parameters.

For example, for a form component based on SCOTT.EMP table returns the following:

_show_header
_rowid
EMPNO
ENAME
JOB, etc.

Except for _show_header and _rowid, the rest are the columns of the table on which the form component is based. These parameters can be used as described in the wwa_app_module.link examples.

Exceptions:

None.

Example:

declare

l_params wwpro_api_provider.portlet_parameter_table;

begin

l_params := <portal_schema>.describe_portlet_parameters
(

p_provider_id => <provider_id>,
p_portlet_id => 1100897857,
p_language => <portal_schema>.wwctx_api.get_nls_language

);

end;

Version: Oracle Portal 3.0.9
Parameters:
p_provider_id	The ID of the provider through which the form component is accessed as a portlet. Datatype: integer
p_portlet_id	The module ID of the form component. Datatype: integer
p_language	The language setting of the Portal. This can be accessed via <portal_schema>.wwctx_api.get_nls_language Datatype:varchar2
Return: This function returns a table of public portlet parameters. For example, for a form component based on SCOTT.EMP table returns the following: _show_header _rowid EMPNO ENAME JOB, etc. Except for _show_header and _rowid, the rest are the columns of the table on which the form component is based. These parameters can be used as described in the wwa_app_module.link examples. Exceptions: None. Example: declare l_params wwpro_api_provider.portlet_parameter_table; begin l_params := <portal_schema>.describe_portlet_parameters ( p_provider_id => <provider_id>, p_portlet_id => 1100897857, p_language => <portal_schema>.wwctx_api.get_nls_language ); end;

Related topics
Form component API package	PDK PL/SQL API Reference - Home