get_attribute_as_string member function

Related topics

Contained in package wwsto_api_session.

Call this function to return the value of a string attribute.

Get the value of the attribute, represented as a type-specific, NLS formatted string.

This function returns the value of the specified attribute as a text string. The text string is obtained by calling upon the attribute's type handling object to convert it from its native form into string form.

Note: The attribute type may have performed extensive transformation on the data value before returning it.

member function get_attribute_as_string

(

p_name in varchar2,

p_language in varchar2,

p_type_name in varchar2 default 'STRING'

)

return varchar2;

Version: Oracle Portal 3.0.6.6.5 or later

Parameters:

p_name

The name of the attribute.

Datatype: in varchar2

p_language

The language to be used for all value transformations.

Datatype: in varchar2

p_type_name

The name of the datatype.

Datatype: in varchar2
Default: 'STRING'

Returns:

This function returns return the text string version of the attribute value, transformed according to a set of rules defined against the attribute's type, or null if not found.

Exceptions:

If the attribute's type indicates that the implementation type is not a string, a VALUE_ERROR exception is raised.

Example:

l_color := l_user_obj.get_attribute_as_string

(

p_name => 'BGCOLOR',

p_language => wwnls_api.AMERICAN

);

Version: Oracle Portal 3.0.6.6.5 or later
Parameters:
p_name	The name of the attribute. Datatype: in varchar2
p_language	The language to be used for all value transformations. Datatype: in varchar2
p_type_name	The name of the datatype. Datatype: in varchar2 Default: 'STRING'
Returns: This function returns return the text string version of the attribute value, transformed according to a set of rules defined against the attribute's type, or null if not found. Exceptions: If the attribute's type indicates that the implementation type is not a string, a VALUE_ERROR exception is raised. Example: l_color := l_user_obj.get_attribute_as_string ( p_name => 'BGCOLOR', p_language => wwnls_api.AMERICAN );

Related topics
Session storage API package	PDK PL/SQL API Reference - Home