National language support API package

Related topics

These APIs are in the wwnls_api API package and provide general access to the National Language Support subsystem. With the methods in this package you can do the following: Store all the string translations for a particular portlet or product. Merge NLS strings and data values to form printable strings. Provide a default message for display if a particular language is not available. The NLS API package provides a set of language name constants to use when specifying language information for translatable strings. This topic presents reference topics and method names and descriptions. NLS API (wwnls_api) topic names and descriptions NLS language constants Presents the NLS language constants used to specify a language for the language message strings. NLS territory constants Presents the NLS territory constants. NLS API package constants Presents other NLS API package constants. NLS exceptions Presents the exceptions defined in the NLS package. NLS string records and table structure Presents the types of string records in which language text is stored in the NLS tables. get_language function Returns the NLS language name constant that indicates the default language for the domain. get_string function (id, language) Returns string text based on a string ID. get_string function (domain, subdomain, name, language) Returns string text based on domain, subdomain, name, and language. Parameter substitution is permitted. get_string_ record function (id, language) Returns a message string record for a string ID, in the specified language. Parameter substitution is permitted. get_string_ record function (domain, subdomain, name, language) Returns a message record. If the specified translation is not found, the base message string is returned. Parameter substitution is permitted. get_base_string_record Returns a specified base string record. copy_string procedure Copies all language strings for a specified name. copy_string function Copies all language strings, given a string ID. get_id function Returns a string ID specified by domain, sub-domain, name, and language. add_string function Adds or modifies a translation for an existing message string. get_translations (domain, subdomain, name) Return all the translations of a string given domain, sub-domain and name. get_translations (id) Return all the translations of a string given a string ID. set_string procedure (id, text) Adds or modifies a translation for an existing message string. set_string procedure (multiple parameters) Adds or modifies a translation for an existing message string. remove_string function (id) Removes either a single translation of a string, or all translations of a string. remove_string function (multiple parameters) Removes either a single translation of a string, or all translations of the string. remove_string_name_like function Removes all strings based on a specified pattern of their names. http_to_nls procedure Maps an HTTP language abbreviation to the corresponding NLS language name. http_to_nls function Maps an HTTP language abbreviation to the corresponding NLS language name. nls_to_http function Maps a NLS language name to the corresponding HTTP language abbreviation. get_schema_ language function Returns a list of the languages installed in the Oracle Portal schema. get_translation_language function Returns the languages available for user data translation. get_preferred_nls_language function Returns the NLS language used to display messages. get_preferred_http_language function Returns the browser language. get_preferred_trans_language function Returns the NLS language used for displaying translations. get_preferred_territory function Returns the database territory that matches a selected HTTP language. is_valid_http_language function Determines whether a given HTTP language abbreviation is valid. is_valid_nls_language function Determines whether a given NLS language abbreviation is valid. is_valid_territory function Determines whether a given territory code is valid. territory_from_http_language function Determines the default territory corresponding to a given HTTP language abbreviation. db_to_http_territory function Determines the HTTP territory corresponding to a given database territory. is_language_permitted function Determines if a given language is available. get_valid_translation_language function Checks if a specific language is enabled for translations.

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