Content Area API Packages

Warning - Content Area APIs available in 3.0.8.x and 3.0.9.x will not work with the initial version of Oracle9iAS Portal 9.0.2 (Version 9.0.2). These APIs will be made available in the PDK release after the next version of Oracle9iAS Portal Release 2, currently scheduled for Q2CY2003. This next release of Oracle9iAS Portal will also contain scripts to upgrade the 3.0.9 release to Oracle9iAS Portal Release 2.

Content area APIs are in the packages wwsbr_api and wwsbr_search_api. With the methods in these packages you can create the following:

  • Content areas
  • Folders
  • Items
  • Custom search screens

Note: You must Commit between creating a new folder and adding items to that folder. If required, a series of add_item calls can be specified. However, you must Commit once all of your item creation calls are complete.

There is a companion script to these packages called sbrapi.sql This script accepts one parameter and will grant select on all the secured content area api views (created in sbrapi.vw) and grant execute on these packages (wwsbr_api and wwsbr_search_api) to the passed SCHEMA. This script must be run as the SCHEMA_OWNER.

This topic presents reference topics and method names and descriptions.

Content area API (wwsbr_api) method names and descriptions

add_content_area function

Creates a new content area.

add_folder function

Creates a new folder in a content area.

add_item function

Creates a new item in a content area.

add_item_post_upload function

Creates a new item in a content area based on files already uploaded into the document repository.

modify_item function

Modifies an item in a content area.

modify_item_post_upload function

Modifies an item based on files already uploaded into the document repository.

enable_ils_for_item procedure

Enables item-level privileges for an item.

inherit_folder_privileges procedure

Specifies that items inherit privileges from their folder.

add_item_ils_privileges procedure

Adds item-level privileges for one or more users/groups to a single specified item.

delete_ils_privilege procedure

Deletes item-level privileges for a single user/group on a single specified item.

Content area search API (wwsbr_search_api) method names and descriptions

submit_search procedure

Generates content area search screens.

Reference topic names and descriptions

Content area constants

Presents the constants defined in the content area API packages.

Content area exceptions

Presents the exceptions defined in the content area API packages.

Secured content area views

Database views which can be used in conjunction with the content area API packages.

Related topics

 

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