deregister_provider procedure (id)

Related topics

Contained in package wwpro_api_provider_registry.

Call this procedure to remove one or more providers' registration records from the provider registry, given a provider ID. When called, deregister_provider calls the provider's deregister procedure. The portlet repository is updated.

Notes:

  • When the implementation type is PL/SQL, this overloaded API does not remove the provider schema or provider implementation packages. The caller must remove these separately, if required.

  • Providers may also be removed using the deregister_provider (owner) procedure.

  • Providers marked as 'non-deleteable' are not removed.

 

procedure deregister_provider
  (
  p_id in integer,
  p_supress_exception in integer default RAISE_PROVIDER_EXCPT
  );

Deleting a provider disables all portlet instances for that provider. To reinstate a deleted provider, use the wwpro_api_provider_registry.register_provider function with the original provider ID. The provider's disabled portlets are then restored.

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

Version: Oracle Portal 3.0.6.6.5 or later

Parameters:

p_id

A unique identifier for the portlet provider to be deregistered.

Note: A null value is not permitted.

Datatype: in integer

p_supress_exception

Indicates whether to suppress failure of the provider deregister function.

  • If this parameter is set to RAISE_PROVIDER_EXCPT and a provider raises an exception in its deregister provider function, a wwpro_api_provider.PROVIDER_CALLDEREG_EXCEPTION exception is raised.

  • If this parameter is set to SUPPRESS_PROVIDER_EXCPT and a call to the providers deregister function fails, the exception is suppressed.

Datatype: in integer
Default: RAISE_PROVIDER_EXCPT

Exceptions:

  • If the user has insufficient privileges to run this API, wwpro_api_provider.PROVIDER_SECURITY_EXCEPTION is raised.

  • If the provider is not found, if an execution is raised, if the provider is not a local provider, or if an attempt is made to deregister a provider marked as non-deleteable, wwpro_api_provider.PROVIDER_REMOVAL_EXCEPTION is raised .

  • If an exception is raised when calling the provider's deregister method, wwpro_api_provider.PROVIDER_CALLDEREG_EXCEPTION is raised.

Example:

l_provider_id := 92837;
wwpro_api_provider_registry.deregister_provider
(
   p_id=>l_provider_id,
   p_supress_exception=>wwpro_api_provider_registry.SUPPRESS_PROVIDER_EXCPT
);

Notes

  • An overloaded API has more than one function or procedure of the same name, each having differing numbers and/or types of parameters.

  • A portlet instance is the display of a portlet on a single page. The same portlet may be displayed multiple times on the same page. Each time a portlet is added to a page, Oracle Portal generates a unique portlet instance ID that is the instance's reference path.

Related topics

Back to top

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