Preference API packages

Related topics

The wwpre_api_name, wwpre_api_value and wwpre_api_util preference API packages provide the methods for performing all the operations necessary for working with user preferences on Oracle Portal objects. wwpre_api_name methods create and delete preference paths and preference names. wwpre_api_value methods set, get, and delete preference values. wwpre_api_util methods resolve the preference path, retrieve the path ID and retrieve the preference name record. This package is like the other preference store packages in that it is granted to the providers in the provsyns.sql script. Topics at the bottom of this page provide preference reference information. Preference store name API (wwpre_api_name) method names and descriptions create_path procedure Creates a hierarchical naming system for the storage of preferences. create_name procedure Creates a preference name used to store preference values. delete_path procedure Deletes a preference path. delete_name procedure Deletes a preference name. Preference values API (wwpre_api_value) method names and descriptions get_value_as_ varchar2 function Returns a preference value as varchar2 using a level name. get_value_as_ date function Returns the preference value as a date using a level name. get_value_as_ number function Returns the preference value as a number using a level name. get_value_as_ string function Returns the preference value as a string using a level name. get_value_as_ varchar2_by_id function Returns a preference value as varchar2 using a level ID. get_value_as_ date_ by_id function Returns the preference value as a date using a level ID. get_value_as_ number_by_id function Returns the preference value as a number using a level ID. get_value_ as_string_ by_id function Returns the preference value as a string using a level ID. set_value_as_ varchar2 procedure Sets a varchar2 value for a preference using a level name. set_value_as_ date procedure Sets a date value for a preference using a level name. set_value_as_ number procedure Sets a number value for a preference using a level name. set_value_as_ string procedure Sets a string value for a preference using a level name. set_value_as_ varchar2_ by_id procedure Sets a varchar2 value for a preference using a level ID. set_value_as_ date_by_id procedure Sets a date value for a preference using a level ID. set_value_as_ number_by_id procedure Sets a number value for a preference using a level ID. set_value_as_ string_by_id procedure Sets a string value for a preference using a level ID. delete_value procedure Deletes the value of a preference based on its level name. delete_value_ by_id procedure Deletes the value of a preference based on its level ID. Preference store utility API (wwpre_api_util) method names and descriptions get_path_id function Gets the preference path ID. get_name function Gets the preference name record. get_names_table function Gets the table of preference name records. get_values_table function Gets the table of preference value records. copy procedure Copies all the names and values for a given path. name_record & value_record Preference packages reference topics Preference names and paths Presents the logic and use of preference names and paths. Preference values Explains working with preference values. Preference store value constants Presents the value constants used in the preference API packages. Preference store name exceptions Presents the exceptions that can be raised by the preference API packages.

Related topics
PDK PL/SQL API Reference - Home

Back to top

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