Oracle9iAS Portal Developer Kit

Preference values

The wwpre_api_value package contains methods that are used to store and retrieve the following items:

  • portlet-specific preferences

  • values that define styles used by pages
  • system-wide global settings

Preference storage settings are unique to each portlet instance, based on a hierarchical name space and persistence. Different methods provide access preference values according to the implementation type: varchar2, date, number, or string.

Preference values associated with preference names are stored in native form. That is, the attribute might have been defined to use the logical type COLOR, which has a native implementation type of varchar2. So the value for this attribute is stored as type COLOR in varchar2.

For a given preference name, values can be set (and scoped) at different levels: user, group, or system-wide. For a user-level or a group-level setting, a valid user name, user ID, group name, or group ID must be specified.

wwpre_api_value.set_value_as_string

(

 

'ORACLE.TOOLS.PORTAL.STYLE',

-- preference path

'BGCOLOR',

-- preference name

wwpre_api_value.USER_LEVEL_TYPE,

-- level name

wwctx_api.get_user,

-- level type constant

wwnls_api.AMERICAN,

-- language constant used to load the type

'#FFCCFF'

-- level_id can be used instead of level_name

);

 

Note: 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

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