get_provider_list function (by ID)

Related topics

Contained in package wwpro_api_node_registry.

Call this function to return a list of providers, by ID, that belong to the specified node.

Notes:

If p_id is passed as null, a list of all providers across all nodes is returned.

The call can be filtered with the provider distribution flag.

function get_provider_list

(

p_id in integer,

p_prov_dist_flag in boolean

)

return wwpro_api_provider_registry.provider_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_id

The ID of the node from which a list of providers should be returned.

Note: If null, a complete list of providers from all registered nodes is returned.

Datatype: in integer

p_prov_dist_
flag

A flag that indicates if this function should return only providers that are marked as distributable.

Notes:

If TRUE, only distributable providers are returned.

If FALSE, all providers for the node specified in p_id are returned.

Because all registered remote providers are always distributable, this flag filters out only non-distributable providers on the local node.

Datatype: Boolean

Returns:

This function returns a list of registered providers.

Exceptions:

This function raises no user-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_id => null

);

Notes

Distributed providers are providers that exist on remote nodes.

A database link is an object stored in the local database that identifies a remote database, a communication path to the remote database, and, optionally, a username and password for it. Once defined, the database link is used to perform queries on tables in the remote database.

Version: Oracle Portal 3.0.6.6.5 or later Deprecated: Oracle9iAS Portal 9.0.2
Parameters:
p_id	The ID of the node from which a list of providers should be returned. Note: If null, a complete list of providers from all registered nodes is returned. Datatype: in integer
p_prov_dist_ flag	A flag that indicates if this function should return only providers that are marked as distributable. Notes: If TRUE, only distributable providers are returned. If FALSE, all providers for the node specified in p_id are returned. Because all registered remote providers are always distributable, this flag filters out only non-distributable providers on the local node. Datatype: Boolean
Returns: This function returns a list of registered providers. Exceptions: This function raises no user-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_id => null );

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