get_provider_list function (by name)

Related topics

Contained in package wwpro_api_node_registry.

Call this function to return a list of registered providers that belong to the specified node(s).

Notes:

This API is similar to wwpro_api_provider_registry.get_provider_list (by ID). However, a NULL or false value for prov_dist_flag returns a list of all providers.

The provider list is ordered by node name.

function get_provider_list

(

p_name in varchar2,

p_prov_dist_flag in boolean,

p_start_row in integer default 1,

p_row_count in integer default 100

)

return wwpro_api_provider_registry.provider_id_table;

Any user can use this function.

Version: Oracle Portal 3.0.6.6.5 or later
Deprecated: Oracle9iAS Portal 9.0.2

Parameters:

p_name

The name of the node from which providers should be returned.

Note: You can use the wild card operators % and _ when specifying node names.

Datatype: in varchar2

p_prov_dist_
flag

A flag that indicates if only those local providers that are marked as distributable to remote nodes should be returned.

Notes:

If this parameter is FALSE or NULL, a list of all providers is returned.

If this parameter is TRUE, only distributable nodes are returned (for the specified name).

Because all registered remote providers are always distributable, this flag prevents only non-distributable providers on the local node from being returned.

Datatype: Boolean

p_start_row

The number of the first table row to be returned.

Note: This parameter and p_row_count are used for report pagination.

Datatype: in integer
Default: 1

p_row_count

The number of rows the table should contain.

Datatype: in integer
Default: 100

Returns:

A list of registered providers.

Exceptions:

This function has no user-defined exceptions.

Note: This and other provider node APIs add error messages to the error stack before they raise exceptions. This allows users to interrogate the error stack if a problem occurs.

Example:

l_provider_list := wwpro_api_node_registry.get_provider_list

(

p_name => 'PORTAL30'

);

Version: Oracle Portal 3.0.6.6.5 or later Deprecated: Oracle9iAS Portal 9.0.2
Parameters:
p_name	The name of the node from which providers should be returned. Note: You can use the wild card operators % and _ when specifying node names. Datatype: in varchar2
p_prov_dist_ flag	A flag that indicates if only those local providers that are marked as distributable to remote nodes should be returned. Notes: If this parameter is FALSE or NULL, a list of all providers is returned. If this parameter is TRUE, only distributable nodes are returned (for the specified name). Because all registered remote providers are always distributable, this flag prevents only non-distributable providers on the local node from being returned. Datatype: Boolean
p_start_row	The number of the first table row to be returned. Note: This parameter and p_row_count are used for report pagination. Datatype: in integer Default: 1
p_row_count	The number of rows the table should contain. Datatype: in integer Default: 100
Returns: A list of registered providers. Exceptions: This function has no user-defined exceptions. Note: This and other provider node APIs add error messages to the error stack before they raise exceptions. This allows users to interrogate the error stack if a problem occurs. Example: l_provider_list := wwpro_api_node_registry.get_provider_list ( p_name => 'PORTAL30' );

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