Oracle9iAS Portal Developer Kit

register_node function

Contained in package wwpro_api_node_registry.

Call this function to register a remote node. Oracle Portal returns the node ID.

Notes:

  • Remote node names are retrieved from remote nodes and validated during registration.

  • When a remote node is registered, the providers on the node are also registered by retrieving the provider records through the database link.
  • This function cannot be used to register the local node.

function register_node

(

p_node_record in node_record

)

return integer;

A user must have the All Provider Manage or All Provider Publish privilege to register a provider node.

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

Parameters:

p_node_record

A node_record structure.

Datatype: in node_record

Returns:

This function returns a node ID.

Exceptions:

  • If the user has insufficient privileges to perform this operation, a PROVIDER_SECURITY_EXCEPTION is raised.

  • If the specified node record causes an attempt to register the node as local, a NOT_VALID_FOR_LOCAL_NODE exception is raised.
  • If an error occurs while trying to add the node, a NODE_VALIDATION_EXCEPTION is raised.
  • If the database link could not be created or was invalid, a NODE_DB_LINK_EXCEPTION is raised.

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_node_id := wwpro_api_node_registry.register_node

(

p_node_record => l_node_record

);

Note

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 remove database.

Related topics

The PL/SQL API Reference is part of the Portal Developer Kit on Portal Studio