set_value_as_string_by

set_value_as_string_by_id procedure

Related topics

Contained in package wwpre_api_value.

Call this procedure to set the value for a preference as a type-specific text string identified by level ID.

procedure set_value_as_string_by_id

(

p_path in varchar2,

p_name in varchar2,

p_level_type in varchar2,

p_level_id in integer,

p_value in varchar2,

p_language in varchar2,

p_commit in boolean default FALSE

);

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 type of level at which the value is stored.

Datatype: in varchar2

p_level_id

Then user ID or group ID for which the value is stored.

Note: If the level type is SYSTEM, then level ID must be wwpre_api_value.SYSTEM_LEVEL_ID.

Datatype: in integer

p_value

The preference value to be stored.

Datatype: in varchar2

p_language

The language to be used for value transformations.

Datatype: in varchar2

p_commit

This parameter is now obsolete. It is left here only to ensure that when older code is used, it still compiles.

Exceptions:

If the string value does not conform to the type, VALUE_ERROR_EXCEPTION is raised.

If the path is not found, PATH_NOT_FOUND_EXCEPTION is raised.

If a duplicate path is found, DUPLICATE_PATH_EXCEPTION is raised.

If the name is not found, NAME_NOT_FOUND_EXCEPTION is raised.

If a duplicate preference name exists for the specified path, DUPLICATE_NAME_EXCEPTION is raised.

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

Example:

This example sets the page color to #FF0000 for user SCOTT, at the user level.

wwpre_api_value.set_value_as_string_by_id

(

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

p_name => 'PAGECOLOR',

p_level_type => wwpre_api_value.USER_LEVEL_TYPE,

p_level_id => wwctx_api.id('SCOTT'),

p_value => '#FF0000',

p_language => wwctx_api.get_nls_language

);

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 type of level at which the value is stored. Datatype: in varchar2
p_level_id	Then user ID or group ID for which the value is stored. Note: If the level type is SYSTEM, then level ID must be wwpre_api_value.SYSTEM_LEVEL_ID. Datatype: in integer
p_value	The preference value to be stored. Datatype: in varchar2
p_language	The language to be used for value transformations. Datatype: in varchar2
p_commit	This parameter is now obsolete. It is left here only to ensure that when older code is used, it still compiles.
Exceptions: If the string value does not conform to the type, VALUE_ERROR_EXCEPTION is raised. If the path is not found, PATH_NOT_FOUND_EXCEPTION is raised. If a duplicate path is found, DUPLICATE_PATH_EXCEPTION is raised. If the name is not found, NAME_NOT_FOUND_EXCEPTION is raised. If a duplicate preference name exists for the specified path, DUPLICATE_NAME_EXCEPTION is raised. If the value has not been stored, GENERAL_PREFERENCE_EXCEPTION is raised. Example: This example sets the page color to #FF0000 for user SCOTT, at the user level. wwpre_api_value.set_value_as_string_by_id ( p_path => 'ORACLE.PORTAL.TEST.STYLE', p_name => 'PAGECOLOR', p_level_type => wwpre_api_value.USER_LEVEL_TYPE, p_level_id => wwctx_api.id('SCOTT'), p_value => '#FF0000', p_language => wwctx_api.get_nls_language );

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