Package wwnls_api

This package contains methods to access to the National Language Support (NLS) subsystem.

Using methods in this package you can:
- 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.

Scope:

Public

Since:

Oracle Portal 3.0.6.6.5

NLS_EXECUTION_EXCEPTION

NLS_EXECUTION_EXCEPTION exception

The call cannot be executed.

NLS_ID_NOT_FOUND_EXCEPTION

NLS_ID_NOT_FOUND_EXCEPTION exception

The specified message record ID cannot be found.

NLS_VALIDATION_EXCEPTION

NLS_VALIDATION_EXCEPTION exception

A validation error occurred.

nls_http_lang_array

type nls_http_lang_array is table of varchar2(64) index by binary_integer

An array containing http languages

nls_scla_array

type nls_scla_array is table of wwnls_sys_language$.databaseabbreviation%type index by binary_integer

nls_string_domain_type

subtype nls_string_domain_type is wwnls_strings$.domain%type

nls_string_id_type

subtype nls_string_id_type is wwnls_strings$.id%type

nls_string_language_type

subtype nls_string_language_type is wwnls_strings$.language%type

nls_string_name_type

subtype nls_string_name_type is wwnls_strings$.name%type

nls_string_sub_domain_type

subtype nls_string_sub_domain_type is wwnls_strings$.sub_domain%type

nls_string_text_string

subtype nls_string_text_string is wwnls_strings$.text_string%type

nls_string_text_type

subtype nls_string_text_type is wwnls_strings$.text%type

string_array

type string_array is table of string_record index by binary_integer

string_record

subtype string_record is wwnls_strings$%rowtype

string_text_array

type string_text_array is table of wwnls_strings$.text%type index by binary_integer

AMERICAN

AMERICAN constant wwnls_strings$.language%type := 'us'

ARABIC

ARABIC constant wwnls_strings$.language%type := 'ar'

BRAZILIANPORTUGUESE

BRAZILIANPORTUGUESE constant wwnls_strings$.language%type := 'ptb'

BULGARIAN

BULGARIAN constant wwnls_strings$.language%type := 'bg'

CANADIANFRENCH

CANADIANFRENCH constant wwnls_strings$.language%type := 'frc'

CATALAN

CATALAN constant wwnls_strings$.language%type := 'ca'

CROATIAN

CROATIAN constant wwnls_strings$.language%type := 'hr'

CZECH

CZECH constant wwnls_strings$.language%type := 'cs'

DANISH

DANISH constant wwnls_strings$.language%type := 'dk'

DEFAULT_HTTP_LANG_AND_TERR

DEFAULT_HTTP_LANG_AND_TERR constant varchar2(5) := 'en-us'

DEFAULT_HTTP_LANGUAGE

DEFAULT_HTTP_LANGUAGE constant varchar2(2) := 'en'

DOMAIN_WSRP

DOMAIN_WSRP constant varchar2(24) := 'wsrp'

Reserved domain name. For internal use only.

DOMAIN_WWC

DOMAIN_WWC constant varchar2(24) := 'wwc'

Reserved domain name. For internal use only.

DOMAIN_WWF

DOMAIN_WWF constant varchar2(24) := 'wwf'

Reserved domain name. For internal use only.

DOMAIN_WWS

DOMAIN_WWS constant varchar2(24) := 'wws'

Reserved domain name. For internal use only.

DOMAIN_WWU

DOMAIN_WWU constant varchar2(24) := 'wwu'

Reserved domain name. For internal use only.

DOMAIN_WWV

DOMAIN_WWV constant varchar2(24) := 'wwv'

Reserved domain name. For internal use only.

DUTCH

DUTCH constant wwnls_strings$.language%type := 'nl'

EGYPTIAN

EGYPTIAN constant wwnls_strings$.language%type := 'eg'

ENGLISH

ENGLISH constant wwnls_strings$.language%type := 'gb'

ESTONIAN

ESTONIAN constant wwnls_strings$.language%type := 'et'

FINNISH

FINNISH constant wwnls_strings$.language%type := 'sf'

FRENCH

FRENCH constant wwnls_strings$.language%type := 'f'

GERMAN

GERMAN constant wwnls_strings$.language%type := 'd'

GERMANDIN

GERMANDIN constant wwnls_strings$.language%type := 'din'

GREEK

GREEK constant wwnls_strings$.language%type := 'el'

HEBREW

HEBREW constant wwnls_strings$.language%type := 'iw'

HONGKONGCHINESE

HONGKONGCHINESE constant wwnls_strings$.language%type := 'zht'

HUNGARIAN

HUNGARIAN constant wwnls_strings$.language%type := 'hu'

ICELANDIC

ICELANDIC constant wwnls_strings$.language%type := 'is'

INDONESIAN

INDONESIAN constant wwnls_strings$.language%type := 'in'

ITALIAN

ITALIAN constant wwnls_strings$.language%type := 'i'

JAPANESE

JAPANESE constant wwnls_strings$.language%type := 'ja'

KOREAN

KOREAN constant wwnls_strings$.language%type := 'ko'

LANGUAGE_SEPARATOR

LANGUAGE_SEPARATOR constant char(1) := ','

LANGUAGE_SUB_SEPARATOR

LANGUAGE_SUB_SEPARATOR constant char(1) := ';'

LATINAMERICANSPANISH

LATINAMERICANSPANISH constant wwnls_strings$.language%type := 'esa'

LATVIAN

LATVIAN constant wwnls_strings$.language%type := 'lv'

LITHUANIAN

LITHUANIAN constant wwnls_strings$.language%type := 'lt'

MALAY

MALAY constant wwnls_strings$.language%type := 'ms'

MEXICANSPANISH

MEXICANSPANISH constant wwnls_strings$.language%type := 'esm'

NLS_DEFAULT_LANGUAGE

NLS_DEFAULT_LANGUAGE constant wwnls_strings$.language%type := 'us'

NLS_DEFAULT_TERRITORY

NLS_DEFAULT_TERRITORY constant varchar2(30) := 'AMERICA'

Default territory

NORWEGIAN

NORWEGIAN constant wwnls_strings$.language%type := 'n'

PERSISTENT_DELIMITER

PERSISTENT_DELIMITER constant char(1) := '+'

POLISH

POLISH constant wwnls_strings$.language%type := 'pl'

PORTUGUESE

PORTUGUESE constant wwnls_strings$.language%type := 'pt'

ROMANIAN

ROMANIAN constant wwnls_strings$.language%type := 'ro'

RUSSIAN

RUSSIAN constant wwnls_strings$.language%type := 'ru'

SIMPLIFIEDCHINESE

SIMPLIFIEDCHINESE constant wwnls_strings$.language%type := 'zhs'

SINGAPORECHINESE

SINGAPORECHINESE constant wwnls_strings$.language%type := 'zhs'

SLOVAK

SLOVAK constant wwnls_strings$.language%type := 'sk'

SLOVENIAN

SLOVENIAN constant wwnls_strings$.language%type := 'sl'

SPANISH

SPANISH constant wwnls_strings$.language%type := 'e'

SUBDOMAIN_POB

SUBDOMAIN_POB constant varchar2(12) := 'pob'

Reserved subdomain name. For internal use only.

SWEDISH

SWEDISH constant wwnls_strings$.language%type := 's'

TER_ALGERIA

TER_ALGERIA constant varchar2(30) := 'ALGERIA'

TER_AMERICA

TER_AMERICA constant varchar2(30) := 'AMERICA'

TER_AUSTRALIA

TER_AUSTRALIA constant varchar2(30) := 'AUSTRALIA'

TER_AUSTRIA

TER_AUSTRIA constant varchar2(30) := 'AUSTRIA'

TER_BAHRAIN

TER_BAHRAIN constant varchar2(30) := 'BAHRAIN'

TER_BANGLADESH

TER_BANGLADESH constant varchar2(30) := 'BANGLADESH'

TER_BELGIUM

TER_BELGIUM constant varchar2(30) := 'BELGIUM'

TER_BRAZIL

TER_BRAZIL constant varchar2(30) := 'BRAZIL'

TER_BULGARIA

TER_BULGARIA constant varchar2(30) := 'BULGARIA'

TER_CANADA

TER_CANADA constant varchar2(30) := 'CANADA'

TER_CATALONIA

TER_CATALONIA constant varchar2(30) := 'CATALONIA'

TER_CHILE

TER_CHILE constant varchar2(30) := 'CHILE'

TER_CHINA

TER_CHINA constant varchar2(30) := 'CHINA'

TER_CIS

TER_CIS constant varchar2(30) := 'CIS'

TER_COLOMBIA

TER_COLOMBIA constant varchar2(30) := 'COLOMBIA'

TER_COSTA_RICA

TER_COSTA_RICA constant varchar2(30) := 'COSTA RICA'

TER_CROATIA

TER_CROATIA constant varchar2(30) := 'CROATIA'

TER_CYPRUS

TER_CYPRUS constant varchar2(30) := 'CYPRUS'

TER_CZECH_REPUBLIC

TER_CZECH_REPUBLIC constant varchar2(30) := 'CZECH REPUBLIC'

TER_DENMARK

TER_DENMARK constant varchar2(30) := 'DENMARK'

TER_DJIBOUTI

TER_DJIBOUTI constant varchar2(30) := 'DJIBOUTI'

TER_EGYPT

TER_EGYPT constant varchar2(30) := 'EGYPT'

TER_EL_SALVADOR

TER_EL_SALVADOR constant varchar2(30) := 'EL SALVADOR'

TER_ESTONIA

TER_ESTONIA constant varchar2(30) := 'ESTONIA'

TER_FINLAND

TER_FINLAND constant varchar2(30) := 'FINLAND'

TER_FRANCE

TER_FRANCE constant varchar2(30) := 'FRANCE'

TER_GERMANY

TER_GERMANY constant varchar2(30) := 'GERMANY'

TER_GREECE

TER_GREECE constant varchar2(30) := 'GREECE'

TER_GUATEMALA

TER_GUATEMALA constant varchar2(30) := 'GUATEMALA'

TER_HONG_KONG

TER_HONG_KONG constant varchar2(30) := 'HONG KONG'

TER_HUNGARY

TER_HUNGARY constant varchar2(30) := 'HUNGARY'

TER_ICELAND

TER_ICELAND constant varchar2(30) := 'ICELAND'

TER_INDIA

TER_INDIA constant varchar2(30) := 'INDIA'

TER_INDONESIA

TER_INDONESIA constant varchar2(30) := 'INDONESIA'

TER_IRAQ

TER_IRAQ constant varchar2(30) := 'IRAQ'

TER_IRELAND

TER_IRELAND constant varchar2(30) := 'IRELAND'

TER_ISRAEL

TER_ISRAEL constant varchar2(30) := 'ISRAEL'

TER_ITALY

TER_ITALY constant varchar2(30) := 'ITALY'

TER_JAPAN

TER_JAPAN constant varchar2(30) := 'JAPAN'

TER_JORDAN

TER_JORDAN constant varchar2(30) := 'JORDAN'

TER_KAZAKHSTAN

TER_KAZAKHSTAN constant varchar2(30) := 'KAZAKHSTAN'

TER_KOREA

TER_KOREA constant varchar2(30) := 'KOREA'

TER_KUWAIT

TER_KUWAIT constant varchar2(30) := 'KUWAIT'

TER_LATVIA

TER_LATVIA constant varchar2(30) := 'LATVIA'

TER_LEBANON

TER_LEBANON constant varchar2(30) := 'LEBANON'

TER_LIBYA

TER_LIBYA constant varchar2(30) := 'LIBYA'

TER_LITHUANIA

TER_LITHUANIA constant varchar2(30) := 'LITHUANIA'

TER_LUXEMBOURG

TER_LUXEMBOURG constant varchar2(30) := 'LUXEMBOURG'

TER_MALAYSIA

TER_MALAYSIA constant varchar2(30) := 'MALAYSIA'

TER_MAURITANIA

TER_MAURITANIA constant varchar2(30) := 'MAURITANIA'

TER_MEXICO

TER_MEXICO constant varchar2(30) := 'MEXICO'

TER_MOROCCO

TER_MOROCCO constant varchar2(30) := 'MOROCCO'

TER_NEW_ZEALAND

TER_NEW_ZEALAND constant varchar2(30) := 'NEW ZEALAND'

TER_NICARAGUA

TER_NICARAGUA constant varchar2(30) := 'NICARAGUA'

TER_NORWAY

TER_NORWAY constant varchar2(30) := 'NORWAY'

TER_OMAN

TER_OMAN constant varchar2(30) := 'OMAN'

TER_PANAMA

TER_PANAMA constant varchar2(30) := 'PANAMA'

TER_PERU

TER_PERU constant varchar2(30) := 'PERU'

TER_POLAND

TER_POLAND constant varchar2(30) := 'POLAND'

TER_PORTUGAL

TER_PORTUGAL constant varchar2(30) := 'PORTUGAL'

TER_PUERTO_RICO

TER_PUERTO_RICO constant varchar2(30) := 'PUERTO RICO'

TER_QATAR

TER_QATAR constant varchar2(30) := 'QATAR'

TER_ROMANIA

TER_ROMANIA constant varchar2(30) := 'ROMANIA'

TER_SAUDI_ARABIA

TER_SAUDI_ARABIA constant varchar2(30) := 'SAUDI ARABIA'

TER_SINGAPORE

TER_SINGAPORE constant varchar2(30) := 'SINGAPORE'

TER_SLOVAKIA

TER_SLOVAKIA constant varchar2(30) := 'SLOVAKIA'

TER_SLOVENIA

TER_SLOVENIA constant varchar2(30) := 'SLOVENIA'

TER_SOMALIA

TER_SOMALIA constant varchar2(30) := 'SOMALIA'

TER_SOUTH_AFRICA

TER_SOUTH_AFRICA constant varchar2(30) := 'SOUTH AFRICA'

TER_SPAIN

TER_SPAIN constant varchar2(30) := 'SPAIN'

TER_SUDAN

TER_SUDAN constant varchar2(30) := 'SUDAN'

TER_SWEDEN

TER_SWEDEN constant varchar2(30) := 'SWEDEN'

TER_SWITZERLAND

TER_SWITZERLAND constant varchar2(30) := 'SWITZERLAND'

TER_SYRIA

TER_SYRIA constant varchar2(30) := 'SYRIA'

TER_TAIWAN

TER_TAIWAN constant varchar2(30) := 'TAIWAN'

TER_THAILAND

TER_THAILAND constant varchar2(30) := 'THAILAND'

TER_THE_NETHERLANDS

TER_THE_NETHERLANDS constant varchar2(30) := 'THE NETHERLANDS'

TER_TUNISIA

TER_TUNISIA constant varchar2(30) := 'TUNISIA'

TER_TURKEY

TER_TURKEY constant varchar2(30) := 'TURKEY'

TER_UKRAINE

TER_UKRAINE constant varchar2(30) := 'UKRAINE'

TER_UNITED_ARAB_EMIRATES

TER_UNITED_ARAB_EMIRATES constant varchar2(30) := 'UNITED ARAB EMIRATES'

TER_UNITED_KINGDOM

TER_UNITED_KINGDOM constant varchar2(30) := 'UNITED KINGDOM'

TER_UZBEKISTAN

TER_UZBEKISTAN constant varchar2(30) := 'UZBEKISTAN'

TER_VENEZUELA

TER_VENEZUELA constant varchar2(30) := 'VENEZUELA'

TER_VIETNAM

TER_VIETNAM constant varchar2(30) := 'VIETNAM'

TER_YEMEN

TER_YEMEN constant varchar2(30) := 'YEMEN'

THAI

THAI constant wwnls_strings$.language%type := 'th'

TRADITIONALCHINESE

TRADITIONALCHINESE constant wwnls_strings$.language%type := 'zht'

TURKISH

TURKISH constant wwnls_strings$.language%type := 'tr'

UKRAINIAN

UKRAINIAN constant wwnls_strings$.language%type := 'uk'

VIETNAMESE

VIETNAMESE constant wwnls_strings$.language%type := 'vn'

null_string_record

null_string_record string_record

add_string

function add_string(
    p_domain in wwnls_strings$.domain%type,
    p_sub_domain in wwnls_strings$.sub_domain%type default 'all',
    p_name in wwnls_strings$.name%type default null,
    p_language in wwnls_strings$.language%type,
    p_text in wwnls_strings$.text%type
) return wwnls_strings$.id%type

Adds or modifies a translation for an existing NLS message string.

Call this function to add a string to the NLS subsystem. This function should be called once for each new string to be added to the system. This function adds the specified string and returns a unique string ID that may be used to identify the string, or to identify translations within the domain and sub-domain. The message strings loaded into the table first, become the base strings for the schema.

Notes:
- This function performs a check to ensure that the string name is unique within the domain, sub-domain, and language.
- If there are multiple translations of a given string, the translations should be added with the set_string function after using the add_string function.

Example:

   if p_input_format_1 is not null then
   l_input_format_id := wwnls_api.add_string
   (
       p_domain        => 'WWC',
       p_sub_domain    => 'EXPLORER',
       p_name          => 'ATTR_INTYPE_FMT',
       p_language      => wwnls_api.AMERICAN,
       p_text          => 'INPUT FORMAT'
   );
   end if;
 

Parameters:

p_domain - the domain in which the message string should be added

p_sub_domain - the sub-domain in which the message string should be added. Note that the default 'all' refers to the name of a specific subdomain. It does not refer to all subdomains.

p_name - a unique name for a message string Note that if nothing is passed in, the string ID is used as the name. If null is specified, the string ID is used as the name.

p_language - the NLS language name constant for the language of the string to be added

p_text - the message string text to be added/modified

Returns:

a unique string ID

Exceptions:

NLS_VALIDATION_EXCEPTION - if a validation error occurs

NLS_EXECUTION_EXCEPTION - if this function fails to execute

Since:

Oracle Portal 3.0.6.6.5

copy_string

procedure copy_string(
    p_source_domain in wwnls_strings$.domain%type,
    p_source_sub_domain in wwnls_strings$.sub_domain%type,
    p_source_name in wwnls_strings$.name%type,
    p_destination_domain in wwnls_strings$.domain%type default null,
    p_destination_sub_domain in wwnls_strings$.sub_domain%type default null,
    p_destination_name in wwnls_strings$.name%type
) 

Copies all language strings for a specified name.

Note: The copy_string procedure can now copy over existing strings.

Example:

   wwnls_api.copy_string
   (
       p_source_domain         => 'domain_from',
       p_source_sub_domain     => 'sub_domain_from',
       p_source_name           => 'source_string',
       p_destination_domain    => 'domain_to',
       p_destination_sub_domain => 'sub_domain_to',
       p_destination_name      => 'copied_string'
   );
 

Parameters:

p_source_domain - the domain that contains the string to be copied

p_source_sub_domain - the subdomain that contains the string to be copied

p_source_name - the name of the string to be copied

p_destination_domain - the domain to receive the copied string If null then source_domain is used.

p_destination_sub_domain - the sub domain to receive the copied string If null then source sub-domain is used

p_destination_name - the name under which the copied string will be saved

Exceptions:

NLS_EXECUTION_EXCEPTION - if the string cannot be copied

Since:

Oracle Portal 3.0.6.6.5

copy_string

function copy_string(
    p_source_nls_id in nls_string_id_type
) return nls_string_id_type

Copies all language strings, given a string ID. The name of the new strings will be their newly generated ID.

Example:

   declare
       l_string_id number;
       l_new_id number;
   begin
       l_string_id := wwnls_api.get_id(
           p_domain        => 'MAP_PROVIDER',
           p_sub_domain    => 'MAP_PORTLET',
           p_name          => 'PORTLET_TITLE',
           p_language      => wwnls_api.AMERICAN);
       l_new_id := wwnls_api.copy_string(
           p_source_nls_id => l_string_id);
   end;
 

Parameters:

p_source_nls_id - the ID of the source string

Exceptions:

NLS_ID_NOT_FOUND_EXCEPTION - if p_source_nls_id is invalid

NLS_VALIDATION_EXCEPTION - if a validation error occurs

NLS_EXECUTION_EXCEPTION - if the string cannot be copied

Since:

Oracle9iAS Portal 9.0.2

db_to_http_territory

function db_to_http_territory(
    p_db_territory in varchar2
) return varchar2

Determines the HTTP territory corresponding to a given database territory.

Example:

   l_http_territory varchar2(10);
   l_http_territory := wwnls_api.db_to_http_territory(
       p_db_territory => 'CANADA'
   );
   -- returns 'ca'
 

Parameters:

p_db_territory - a territory in database format

Returns:

an HTTP territory code

Since:

Oracle9iAS Portal 9.0.2

get_base_string_record

function get_base_string_record(
    p_domain in wwnls_strings$.domain%type,
    p_sub_domain in wwnls_strings$.sub_domain%type default 'all',
    p_name in wwnls_strings$.name%type
) return string_record

Returns a specified base string record, given the domain, subdomain and name.

Example:

    declare
       l_string_record wwnls_api.string_record;
    begin
       l_string_record := wwnls_api.get_base_string_record(
           p_domain     => 'MAP_PROVIDER',
           p_sub_domain => 'MAP_PORTLET',
           p_name       => 'PORTLET_TITLE');
    end;
 

Parameters:

p_domain - the domain for the message string

p_sub_domain - the subdomain in which the message string should be found. Note that the default 'all' refers to the name of a specific subdomain. It does not refer to all subdomains.

p_name - a unique name for a message string

Returns:

the base string_record.

Exceptions:

NLS_ID_NOT_FOUND_EXCEPTION - if the message string ID is not found

NLS_EXECUTION_EXCEPTION - if this function fails to execute

Since:

Oracle Portal 3.0.6.6.5

get_iana_language

function get_iana_language(
    p_http_language in varchar2,
    p_nls_territory in varchar2
) return varchar2

Determines whether the HTTP language contains the IANA country code.

If the passed HTTP language is less than two characters then an exception is raised, otherwise the IANA country code based on the territory passed is appended to the first two characters of the HTTP language.

Example:

     l_iana_lang := wwnls_api.get_iana_language(
         p_http_language => 'en',
         p_nls_territory => wwnls_api.TER_AMERICA
     );
 

Parameters:

p_http_language - the HTTP language abbreviation

p_nls_territory - the NLS territory

Returns:

the HTTP language suffixed with the IANA country code

Exceptions:

VALUE_ERROR - if the length of p_http_language is less than 2

Since:

Oracle9iAS Portal 9.0.2

get_id

function get_id(
    p_domain in wwnls_strings$.domain%type,
    p_sub_domain in wwnls_strings$.sub_domain%type default 'all',
    p_name in wwnls_strings$.name%type,
    p_language in wwnls_strings$.language%type
) return wwnls_strings$.id%type

Returns a string ID specified by domain, sub-domain, name, and language.

Example:

   l_string_id := wwnls_api.get_id
   (
       p_domain        =>'IPORTAL',
       p_sub_domain    =>'TRAIN',
       p_name          => 'WELCOME',
       p_language      => wwnls_api.ARABIC
   );
 

Parameters:

p_domain - the domain in which the message string should be found

p_sub_domain - the subdomain in which the message string should be found. Note that the default 'all' refers to the name of a specific subdomain. It does not refer to all subdomains.

p_name - the unique name of the message string

p_language - the NLS language name constant for the language to be returned. For example: wwnls_api.AMERICAN.

Returns:

a string ID based on a specified domain, sub-domain, string name, and NLS language constant.

Exceptions:

NLS_EXECUTION_EXCEPTION - if this function fails to execute

NLS_ID_NOT_FOUND_EXCEPTION - if the message string ID is not found

Since:

Oracle Portal 3.0.6.6.5

get_installed_http_language

function get_installed_http_language
return nls_http_lang_array

Returns HTTP languages corresponding to the database languages that are installed.

Example: l_http_languages wwnls_api.nls_http_lang_array; l_http_languages := wwnls_api.get_installed_http_language;

Returns:

nls_http_lang_array, an array of HTTP languages

Exceptions:

NLS_EXECUTION_EXCEPTION - if this function fails to execute

Since:

Oracle9iAS Portal 9.0.4

get_language

function get_language(
    p_language in wwnls_strings$.language%type
) return varchar2

Returns the NLS language name constant that indicates the default language for the domain.

Example:

    declare
       l_language varchar(2000)
    begin
       l_language := wwnls_api.get_language
       (
           p_language => 'us'
       );
    end;
 

Parameters:

p_language - a two or three-letter language constant

Returns:

This function returns the full name of the language stored in Oracle Portal NLS tables

Since:

Oracle Portal 3.0.6.6.5

get_preferred_http_language

function get_preferred_http_language
return varchar2

Determines the HTTP language used to derive the NLS language in which to display user messages.

Example:

   l_http_language varchar2(30);
   l_http_language := wwnls_api.get_preferred_http_language;
 

Returns:

the browser language

Since:

Oracle9iAS Portal 9.0.2

get_preferred_nls_language

function get_preferred_nls_language
return varchar2

Determines the NLS language used to display messages.

Example:

   l_nls_language varchar2(30);
   l_nls_language := wwnls_api.get_preferred_nls_language;
 

Returns:

the NLS language

Since:

Oracle9iAS Portal 9.0.2

get_preferred_territory

function get_preferred_territory
return varchar2

Determines the database territory that matches a selected HTTP language.

Example:

   l_territory varchar2(30);
   l_territory := wwnls_api.get_preferred_territory;
 

Returns:

a territory abbreviation

Since:

Oracle9iAS Portal 9.0.2

get_preferred_trans_language

function get_preferred_trans_language
return varchar2

Determines the NLS language used for displaying translations.

Example:

   l_trans_language varchar2(30);
   l_trans_language := wwnls_api.get_preferred_trans_language;
 

Returns:

the translation NLS language

Since:

Oracle9iAS Portal 9.0.2

get_schema_language

function get_schema_language
return nls_scla_array

Returns a list of the languages installed in the Oracle Portal schema.

Example:

   l_languages wwnls_api.nls_scla_array;
   l_languages := wwnls_api.get_schema_language;
 

Returns:

This function returns an array filled with the NLS names of the languages installed in a schema.

Exceptions:

NLS_EXECUTION_EXCEPTION - If this function fails to execute.

Since:

Oracle Portal 3.0.6.6.5

get_string

function get_string(
    p_id in wwnls_strings$.id%type,
    p_language in wwnls_strings$.language%type default null,
    p0 in varchar2 default null,
    p1 in varchar2 default null,
    p2 in varchar2 default null,
    p3 in varchar2 default null,
    p4 in varchar2 default null,
    p5 in varchar2 default null,
    p6 in varchar2 default null,
    p7 in varchar2 default null,
    p8 in varchar2 default null,
    p9 in varchar2 default null
) return varchar2

Returns a NLS string text based on a string ID.

Call this function to return a message string based on the message string ID. If p_language is null, the string specified in p_id is returned. If p_language is not null, the translation specified for the string ID is returned in the language specified in p_language.

Note: This function allows parameter substitution.

Example:

    declare
       l_string_id integer;
       l_string varchar2(200);
    begin
       l_string_id := wwnls_api.get_id
          (p_domain        =>'MAP_PROVIDER',
           p_sub_domain    =>'MAP_PORTLET',
           p_name          =>'PORTLET_TITLE',
           p_language      =>wwnls_api.AMERICAN);

       l_string := wwnls_api.get_string
          (p_id =>l_string_id); -- string returned in English

       l_string := wwnls_api.get_string
          (p_id =>l_string_id,
           p_language=>wwnls_api.HEBREW); -- no translation in Hebrew,
                                             string returned in English
       l_string := wwnls_api.get_string
          (p_id =>l_string_id,
           p_language=>wwnls_api.FRENCH); -- string returned in French
    end;
 

Parameters:

p_id - the message string ID

p_language - the NLS language name constant for the language to be retrieved. For example: wwnls_api.AMERICAN.

p0 - (to p9) values used for parameter substitution. Note that:
- These are optional run-time values that may be inserted into the message string.
- The message string must contain the markup characters %0, %1, through %9 in order to pass in the appropriate parameter value.
- Only the specified non-null values p0 through p9 are used for substitution. Extra values are ignored.
- Only non-null values are used for substitution.

Returns:

if p_language is null, this function returns the string text specified in p_id. If p_language is not null, this function returns the translation specified for the string ID in the language specified in p_language.

Exceptions:

NLS_EXECUTION_EXCEPTION - if this function fails to execute

Since:

Oracle Portal 3.0.6.6.5

get_string

function get_string(
    p_domain in wwnls_strings$.domain%type,
    p_sub_domain in wwnls_strings$.sub_domain%type default 'all',
    p_name in wwnls_strings$.name%type,
    p_language in wwnls_strings$.language%type,
    p0 in varchar2 default null,
    p1 in varchar2 default null,
    p2 in varchar2 default null,
    p3 in varchar2 default null,
    p4 in varchar2 default null,
    p5 in varchar2 default null,
    p6 in varchar2 default null,
    p7 in varchar2 default null,
    p8 in varchar2 default null,
    p9 in varchar2 default null
) return varchar2

Returns an NLS string text based on domain, subdomain, name, and language.

Note: This function allows parameter substitution.

Example:

    declare
       l_string_id integer;
       l_string varchar2(200);
    begin
       l_string := wwnls_api.get_string(
           p_domain => 'MAP_PROVIDER',
           p_sub_domain => 'MAP_PORTLET',
           p_name => 'PORTLET_TITLE',
           p_language => wwnls_api.AMERICAN);
           -- string returned in English
       l_string := wwnls_api.get_string(
           p_domain => 'MAP_PROVIDER',
           p_sub_domain => 'MAP_PORTLET',
           p_name => 'PORTLET_TITLE',
           p_language => wwnls_api.FRENCH);
           -- string returned in French
    end;
 

Parameters:

p_domain - the domain for the message string

p_sub_domain - the subdomain in which the message string should be found. Note that the default 'all' refers to the name of a specific subdomain. It does not refer to all subdomains.

p_name - a unique name for a message string

p_language - the NLS language name constant for the language to be retrieved. For example: wwnls_api.AMERICAN.

p0 - (to p9) values used for parameter substitution. Note that:
- These are optional run-time values that may be inserted into the message string.
- The message string must contain the markup characters %0, %1, through %9 in order to pass in the appropriate parameter value.
- Only the specified non-null values p0 through p9 are used for substitution. Extra values are ignored.
- Only non-null values are used for substitution.

Returns:

if the translation specified in p_language is found, this function returns a string based on domain, subdomain, string name, and language name. If the translation specified in p_language is not found, this function returns the base string.

Exceptions:

NLS_EXECUTION_EXCEPTION - if this function fails to execute

Since:

Oracle Portal 3.0.6.6.5

get_string_record

function get_string_record(
    p_id in wwnls_strings$.id%type,
    p_language in wwnls_strings$.language%type default null
) return string_record

Returns a message string record for a string ID, in the specified language.

Call this function to get a message record for a message string ID and an NLS language constant.

Note: If p_language is null, the message record specified by p_id is returned. If p_language is not null, the message record for the translation of p_id, in the language specified by p_language, is returned.

Example:

    l_string_record := wwnls_api.get_string_record
    (
       p_id        => 12784,
       p_language  => wwnls_api.AMERICAN,
    );
 

Parameters:

p_id - a message record ID number

p_language - the NLS language name constant for the language to be retrieved. For example: wwnls_api.AMERICAN.

Returns:

if p_language is null, the message record specified by p_id is returned. If p_language is not null, the message record specified by p_id is returned in the specified language.

Since:

Oracle Portal 3.0.6.6.5

get_string_record

function get_string_record(
    p_domain in wwnls_strings$.domain%type,
    p_sub_domain in wwnls_strings$.sub_domain%type default 'all',
    p_name in wwnls_strings$.name%type,
    p_language in wwnls_strings$.language%type
) return string_record

Returns a message string record based on domain, sub_domain, name and language.

Call this function to get a message record. If the translation specified in p_language is not found, the base message string is returned.

Notes:
- A base message string is the base string that was created with the add_string function, in the current domain and subdomain, and with the specified name.
- String records in the specified translation may be created only after the base string is added.

Example:

    declare
       l_desc wwnls_api.string_record;
    begin
       l_desc := wwnls_api.get_string_record
       (
           p_domain        =>wwc,
           p_sub_domain    =>'typ',
           p_name          =>'desc_number',
           p_language      =>wwctx_api.get_nls_language
    );
    end;
 

Parameters:

p_domain - the domain in which the message string should be found

p_sub_domain - the subdomain in which the message string should be found. Note that the default 'all' refers to the name of a specific subdomain. It does not refer to all subdomains.

p_name - a unique name for a message string

p_language - the NLS language name constant for the language to be returned. For example: wwnls_api.AMERICAN.

Returns:

if the translation specified in p_language is found, a message record based on domain, subdomain, string name, and language name. If the translation specified in p_language is not found, this function returns the same information for the base string.

Exceptions:

NLS_EXECUTION_EXCEPTION - if this function fails to execute

Since:

Oracle Portal 3.0.6.6.5

get_translation_language

function get_translation_language
return nls_scla_array

Returns the languages available for user data translation.

Example:

   l_languages wwnls_api.nls_scla_array;
   l_languages := wwnls_api.get_translation_language;
 

Returns:

nls_scla_array, an array of available languages

Exceptions:

NLS_EXECUTION_EXCEPTION - if this function fails to execute

Since:

Oracle9iAS Portal 9.0.2

get_translations

function get_translations(
    p_domain in wwnls_strings$.domain%type,
    p_sub_domain in wwnls_strings$.sub_domain%type default 'all',
    p_name in wwnls_strings$.name%type,
    p0 in varchar2 default null,
    p1 in varchar2 default null,
    p2 in varchar2 default null,
    p3 in varchar2 default null,
    p4 in varchar2 default null,
    p5 in varchar2 default null,
    p6 in varchar2 default null,
    p7 in varchar2 default null,
    p8 in varchar2 default null,
    p9 in varchar2 default null
) return string_array

Return all the translations of a string given domain, sub-domain and name.

Example:

    declare
       l_translations wwnls_api.string_array;
    begin
       l_translations := wwnls_api.get_translations(
           p_domain        => 'MAP_PROVIDER',
           p_sub_domain    => 'MAP_PORTLET',
           p_name          => 'PORTLET_TITLE');
    end;
 

Parameters:

p_domain - the domain for the message string

p_sub_domain - the subdomain in which the message string should be found. Note that the default 'all' refers to the name of a specific subdomain. It does not refer to all subdomains.

p_name - a unique name for a message string

p0 - (to p9) values used for parameter substitution. Note that:
- These are optional run-time values that may be inserted into the message string.
- The message string must contain the markup characters %0, %1, through %9 in order to pass in the appropriate parameter value.
- Only the specified non-null values p0 through p9 are used for substitution. Extra values are ignored.
- Only non-null values are used for substitution.

Returns:

a string_array containing all the translations of a string, given the Domain, Sub-Domain and Name.

Exceptions:

NLS_EXECUTION_EXCEPTION - if this function fails to execute

Since:

Oracle Portal 3.0.6.6.5

get_translations

function get_translations(
    p_id in wwnls_strings$.id%type,
    p0 in varchar2 default null,
    p1 in varchar2 default null,
    p2 in varchar2 default null,
    p3 in varchar2 default null,
    p4 in varchar2 default null,
    p5 in varchar2 default null,
    p6 in varchar2 default null,
    p7 in varchar2 default null,
    p8 in varchar2 default null,
    p9 in varchar2 default null
) return string_array

Returns all the translations of a string, given a string ID.

Example:

   declare
       l_string_id number;
       l_translations wwnls_api.string_array;
   begin
       l_string_id := wwnls_api.get_id(
           p_domain => 'MAP_PROVIDER',
           p_sub_domain => 'MAP_PORTLET',
           p_name => 'PORTLET_TITLE',
           p_language => wwnls_api.AMERICAN);
       l_translations := wwnls_api.get_translations(
           p_id => l_string_id);
   end;
 

Parameters:

p_id - the message string ID

p0 - (to p9) values used for parameter substitution. Note that:
- These are optional run-time values that may be inserted into the message string.
- The message string must contain the markup characters %0, %1, through %9 in order to pass in the appropriate parameter value.
- Only the specified non-null values p0 through p9 are used for substitution. Extra values are ignored.
- Only non-null values are used for substitution.

Returns:

a string_array containing all the translations of a string, given message string ID

Exceptions:

NLS_EXECUTION_EXCEPTION - if this function fails to execute

Since:

Oracle9iAS Portal 9.0.2

get_valid_translation_language

function get_valid_translation_language(
    p_translation_language in varchar2
) return varchar2

Checks if a specific language is enabled for translations. If not, then the default language is returned.

Example:

   l_trans_language varchar2(30);
   l_trans_language := wwnls_api.get_valid_translation_language(
       p_translation_language => wwnls_api.SPANISH
   );
 

Parameters:

p_translation_language - the language abbreviation to be checked

Returns:

the language if it can be translated, or the default if not

Since:

Oracle9iAS Portal 9.0.2

http_to_nls

procedure http_to_nls(
    p_http_language in varchar2,
    p_nls_language out varchar2,
    p_found_match out boolean
) 

Maps an HTTP language abbreviation to the corresponding NLS language name.

Example:

   declare
       l_nls_language varchar2(30);
       l_found boolean;
   begin
       wwnls_api.http_to_nls(
           p_http_language     => 'en-us',
           p_nls_language      => l_nls_language,
           p_found_match       => l_found);
   end;
 

Parameters:

p_http_language - an HTTP language abbreviation

p_nls_language - a mapped NLS language abbreviation

p_found_match - indicates whether a match is found

Since:

Oracle9iAS Portal 9.0.2

http_to_nls

function http_to_nls(
    p_language in varchar2
) return varchar2

Maps an HTTP language abbreviation to the corresponding NLS language name.

Note: An HTTP language abbreviation is either a two character language abbreviation or a five character code that consists of a two character language abbreviation followed by a hyphen and a two character country code, e.g. 'en', 'en-gb', 'es', 'es-mx'. The common browsers use these language codes.

Example:

   declare
       l_nls_language varchar(2000);
   begin
       l_nls_language := wwnls_api.http_to_nls
       (
           p_language => 'en-us'
       );
   end;
 

Parameters:

p_language - an HTTP language abbreviation

Returns:

an NLS language name constant for the HTTP abreviation specified

Since:

Oracle Portal 3.0.6.6.5

is_language_permitted

function is_language_permitted(
    p_language in varchar2,
    p_product_messages in boolean default true
) return boolean

Determines if a given language is available.

If the value of p_product_messages is true, the installed flag in wwctx_sys_language$ is checked. If the value of p_product_messages is false, the available flag is checked.

Example:

   if wwnls_api.is_language_permitted(
       p_language => wwnls_api.SPANISH
   )
   then
       .
       .
       .
   end if;
 

Parameters:

p_language - the language abbreviation to be checked

p_product_messages - indicates the flag to be checked:
- True => check Installed flag
- False => check Available flag

Returns:

true if the corresponding flag is 1, false otherwise

Since:

Oracle9iAS Portal 9.0.2

is_valid_http_language

function is_valid_http_language(
    p_http_language in varchar2
) return boolean

Determines whether a given HTTP language abbreviation is valid.

Example:

   if wwnls_api.is_valid_http_language(
       p_http_language => 'en-us'
   )
   then
       .
       .
       .
   end if;
 

Parameters:

p_http_language - an HTTP language abbreviation

Returns:

true if the abbreviation is valid, otherwise false

Since:

Oracle9iAS Portal 9.0.2

is_valid_nls_language

function is_valid_nls_language(
    p_nls_language in varchar2
) return boolean

Determines whether a given NLS language abbreviation is valid.

Example:

   if wwnls_api.is_valid_nls_language(
      p_nls_language =>'us'
   )
   then
        .
        .
        .
   end if;
 

Parameters:

p_nls_language - an NLS language abbreviation

Returns:

true if the abbreviation is valid, otherwise false

Since:

Oracle9iAS Portal 9.0.2

is_valid_territory

function is_valid_territory(
    p_territory in varchar2
) return boolean

Determines whether a given territory code is valid.

Example:

   if wwnls_api.is_valid_territory(
      p_territory => 'AMERICA'
   )
   then
        .
        .
        .
   end if;
 

Parameters:

p_territory - a territory code

Returns:

true if the code is valid, otherwise false

Since:

Oracle9iAS Portal 9.0.2

nls_to_http

function nls_to_http(
    p_nls_language in varchar2
) return varchar2

Maps a NLS language name to the corresponding HTTP language abbreviation. For a given NLS language, there could be multiple HTTP languages based on the territory. In the Oracle Portal schema, an installed NLS language is mapped to just one HTTP language. This function returns the HTTP language that corresponds to an installed NLS language.

Note: An HTTP language abbreviation is either a two character language abbreviation or a five character code that consists of a two character language abbreviation followed by a hyphen and a two character country code, e.g. 'en', 'en-gb', 'es', 'es-mx'. The common browsers use these language codes.

Example:

   declare
       l_http_language varchar(2000)
   begin
       l_http_language := wwnls_api.nls_to_http
       (
           p_nls_language => wwnls_api.AMERICAN
       );
   end;
 

Parameters:

p_nls_language - an NLS language abbreviation

Returns:

a mapped HTTP abbreviation constant for the NLS language name constant specified

Since:

Oracle Portal 3.0.9

remove_string

function remove_string(
    p_domain in wwnls_strings$.domain%type,
    p_sub_domain in wwnls_strings$.sub_domain%type default 'all',
    p_name in wwnls_strings$.name%type,
    p_language in wwnls_strings$.language%type,
    p_remove_all in boolean default false
) return number

Removes either a single translation of a string, or all translations of the string, given domain, sub-domain, name, and language.

Note: If a base string is deleted, all translations for the specified string are deleted.

Example:

   l_number := wwnls_api.remove_string
   (
       p_domain        => 'IPORTAL',
       p_sub_domain    => 'ALL',
       p_name          => 'TEST',
       p_language      => wwnls_api.BULGARIAN,
       p_remove_all    => TRUE
   );
 

Parameters:

p_domain - the domain in which the message string should be found

p_sub_domain - the sub-domain in which the message string should be found. Note that the default 'all' refers to the name of a specific subdomain. It does not refer to all subdomains.

p_name - the unique name for the message string

p_language - the NLS language name constant for the language of the string to be deleted

p_remove_all - indicates if all translations of a string should be removed. TRUE removes all strings of the specified language. FALSE removes only the specified string.

Returns:

the number of rows deleted

Since:

Oracle Portal 3.0.6.6.5

remove_string

function remove_string(
    p_id in wwnls_strings$.id%type,
    p_remove_all in boolean default false
) return number

Removes either a single translation of a string, or all translations of the string, given a message ID.

Note: If a base string is deleted, all translations for the specified string are deleted.

Example:

   l_number := wwnls_api.remove_string
(
p_id            => l_layout.title_id,
p_remove_all    => true
);
 

Parameters:

p_id - a message string ID

p_remove_all - indicates if all translations of a string should be removed. TRUE removes all strings of the specified language. FALSE removes only the specified string.

Returns:

the number of rows deleted

Since:

Oracle Portal 3.0.6.6.5

remove_string_name_like

function remove_string_name_like(
    p_domain in wwnls_strings$.domain%type,
    p_sub_domain in wwnls_strings$.sub_domain%type default 'all',
    p_name in wwnls_strings$.name%type
) return number

Removes all strings based on a specified pattern of their names.

Call this function to delete all strings based on a specified pattern of their names. The wild card '%' can be used to represent zero or more characters and '_' can be used to represent any one character.

Note: If a base string is deleted, all translations for the specified string are deleted.

Example:

   wwnls_api.remove_string_name_like
   (
       p_domain        => 'IPORTAL',
       p_sub_domain    => 'ALL',
       p_name          => 'WEL%'
   );
 

Parameters:

p_domain - the domain in which the message string should be found

p_sub_domain - the sub-domain in which the message string should be found. Note that the default 'all' refers to the name of a specific subdomain. It does not refer to all subdomains.

p_name - the unique name for the message string

Returns:

the number of strings deleted

Since:

Oracle Portal 3.0.6.6.5

set_string

procedure set_string(
    p_domain in wwnls_strings$.domain%type,
    p_sub_domain in wwnls_strings$.sub_domain%type default 'all',
    p_name in wwnls_strings$.name%type,
    p_language in wwnls_strings$.language%type,
    p_text in wwnls_strings$.text%type
) 

Modifies an existing message string or adds a translation for a string, given domain, sub-domain, name, and language.

Example:

   wwnls_api.set_string
   (
       p_domain        => 'IPORTAL',
       p_sub_domain    => 'ALL',
       p_name          => 'TEST',
       p_language      => wwnls_api.JAPANESE,
       p_text          => 'THE JAPANESE TEXT STRING'
   );
 

Parameters:

p_domain - the domain in which the message string should be added

p_sub_domain - the sub-domain in which the message string should be added. Note that the default 'all' refers to the name of a specific subdomain. It does not refer to all subdomains.

p_name - the unique name of the message string

p_language - the NLS language name constant for the language of the string to be added/modified

p_text - the message text to replace the existing text for the specified string

Exceptions:

NLS_VALIDATION_EXCEPTION - if a validation error occurs

NLS_EXECUTION_EXCEPTION - if this function fails to execute

Since:

Oracle Portal 3.0.6.6.5

set_string

procedure set_string(
    p_id in wwnls_strings$.id%type,
    p_text in wwnls_strings$.text%type,
    p_language in wwnls_strings$.language%type default null
) 

Modifies an existing message string or adds a translation for a string, given a message ID.

Example:

   if sql%rowcount != 0 then
       l_long := self.title;
       wwnls_api.set_string
       (
           p_id => self.title_id,
           p_text => l_long
       );
       l_long := self.description;
       wwnls_api.set_string
       (
           p_id => self.description_id,
           p_text => l_long
       );
   else
   ...
 

Parameters:

p_id - a message string ID

p_text - the translated message string text to be modified

p_language - the NLS language name constant of the language for which the translation is provided

Exceptions:

NLS_EXECUTION_EXCEPTION - if this function fails to execute

Since:

Oracle Portal 3.0.6.6.5

territory_from_http_language

function territory_from_http_language(
    p_http_language in varchar2
) return varchar2

Determines the default territory corresponding to a given HTTP language abbreviation.

Example:

   l_territory varchar2(60);
   l_territory := wwnls_api.territory_from_http_language(
       p_http_language => 'en-us'
   );
       -- returns 'AMERICA'
 

Parameters:

p_http_language - an HTTP language abbreviation

Returns:

a territory code

Since:

Oracle9iAS Portal 9.0.2