get_value_as_varchar2 function

Related topics

Contained in package wwpre_api_value.

Call this function to return a preference value as varchar2, if the preference value was stored as varchar2.

Note: For details about returning preference values, see About preference values.

function get_value_as_varchar2

(

p_path in varchar2,

p_name in varchar2,

p_level_type in varchar2 default INHERIT_LEVEL_TYPE,

p_level_name in varchar2 default null

)

return varchar2;

Version: Oracle Portal 3.0.6.6.5 or later

Parameters:

p_path

The path for the preference name.

Datatype: in varchar2

p_name

The preference name.

Datatype: in varchar2

p_level_type

A constant value for the level at which the value is retrieved.

Note: If a value is not specified for p_level_type, this function attempts to inherit the value, moving to each step if a value is not found:

Get the value for the user currently logged in.

Get the default group value for the user currently logged in.

Get the value for the system level type.

Return null if no value is found.

Datatype: in varchar2
Default: INHERIT_LEVEL_TYPE

p_level_name

The user name or group name for which the value will be retrieved.

Notes:

If not specified, this method searches for a valid value based on path, name, and level type.

For user-level or group-level type, the level name or level ID must be specified.

Datatype: in varchar2
Default: null

Returns:

This function returns the preference value as varchar2. It returns null if there is no value or if the preference name was not found.

Exceptions:

If the path is not found, a PATH_NOT_FOUND_EXCEPTION is raised.

If a duplicate path is found, a DUPLICATE_PATH_EXCEPTION is raised.

If the value has not been stored, a GENERAL_PREFERENCE_EXCEPTION is raised.

Example:

This example gets a value for a group.

l_varchar2_value := wwpre_api_value.get_value_as_varchar2

(

p_path => 'ORACLE.PORTAL.TEST.STYLE.DEFAULT',

p_name => 'FONT_NAME',

p_level_type => wwpre_api_value.GROUP_LEVEL_TYPE,

p_level_name => 'TEST_GROUP'

);

Version: Oracle Portal 3.0.6.6.5 or later
Parameters:
p_path	The path for the preference name. Datatype: in varchar2
p_name	The preference name. Datatype: in varchar2
p_level_type	A constant value for the level at which the value is retrieved. Note: If a value is not specified for p_level_type, this function attempts to inherit the value, moving to each step if a value is not found: Get the value for the user currently logged in. Get the default group value for the user currently logged in. Get the value for the system level type. Return null if no value is found. Datatype: in varchar2 Default: INHERIT_LEVEL_TYPE
p_level_name	The user name or group name for which the value will be retrieved. Notes: If not specified, this method searches for a valid value based on path, name, and level type. For user-level or group-level type, the level name or level ID must be specified. Datatype: in varchar2 Default: null
Returns: This function returns the preference value as varchar2. It returns null if there is no value or if the preference name was not found. Exceptions: If the path is not found, a PATH_NOT_FOUND_EXCEPTION is raised. If a duplicate path is found, a DUPLICATE_PATH_EXCEPTION is raised. If the value has not been stored, a GENERAL_PREFERENCE_EXCEPTION is raised. Example: This example gets a value for a group. l_varchar2_value := wwpre_api_value.get_value_as_varchar2 ( p_path => 'ORACLE.PORTAL.TEST.STYLE.DEFAULT', p_name => 'FONT_NAME', p_level_type => wwpre_api_value.GROUP_LEVEL_TYPE, p_level_name => 'TEST_GROUP' );

Related topics
Preference API package	PDK PL/SQL API Reference - Home