PL/SQL API

The Portals PL/SQL API consists of but a few stored procedures:

The portals_install package:

In addition to the above procedures, there is a single procedure stored in a package called portals_install. Here's the header:
create or replace package portals_install as
    procedure add_default_portlet (
        portlet_name		in portal_portlets.portlet_name%TYPE default null,
        data_feed_name		in portal_data_feeds.data_feed_name%TYPE default null,
        group_type		in portal_domains.group_type%TYPE default 'users',
        creation_user		in users.email%TYPE default 'system',
        required_p		in portal_portlets.required_p%TYPE default 'f',
        page_number		in portal_pages.page_number%TYPE default 1,
        link_url		in portal_portlets.link_url%TYPE default null,
        page_side		in portal_portlet_page_map.page_side%TYPE default 'l',
        sort_key		in portal_portlet_page_map.sort_key%TYPE default null,
        adp			in varchar default null
    );
end portals_install;
As you can see, the only available method is add_default_portlet. This procedure will add a default portlet to any particular portal, in any portal domain, on any particular page. It's currently only used during the installation of portals, but if you can find something else to do with it, be my guest. An example of its use (from packages/portals/04-load-default.sql):
execute portals_install.add_default_portlet (
    group_type => 'users',
    portlet_name => 'FAQs',
    data_feed_name => 'FAQS',
    page_number => 1,
    link_url => '<%=[DisplayAddFAQLink]%>',
    page_side => 'r',
    sort_key => 2
);
Note that the above example is broken up over a number of lines for readability. If you plan to use this code in SQL*PLUS, you'll have to put it all on a single line.
$Id: plsql-api.html,v 1.1.1.1 2001/01/24 18:03:35 tarik Exp $
ibaker@arsdigita.com