Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

setLanguages

Synopsis

void setLanguages(
    SessionId sessionId,
    string[] languages,
    SetLanguagesMode mode
)
throws CatalogServiceFault;

See also: SessionId, SetLanguagesMode, CatalogServiceFault

This operation sets the language list of the catalog service (the catalog languages) to the specified, possibly empty list of ISO 639 alpha-2 language codes. It then augments1 this list with the language of the current locale to build an effective list of catalog languages. The effective list of catalog languages is updated after each invocation of the session service’s setLocale operation to reflect possible changes to the locale language.

Natural language texts are returned in the first language from the list of effective catalog languages supported by the catalog database. In case the catalog database does not support any of the listed languages then the Online Configurator returns the text in the first language found.

Instead of a session ID the operation can also be invoked with a session context ID as their first argument (see also §newSessionContext). If so, the session ID stored in the session context will be used as the actual session ID. The languages will be changed for the whole session including all projects loaded in the session.

A CatalogServiceFault is returned if any of the following conditions occurs:

  • The sessionId parameter is not a valid string representation of an UUID or does not represent an open session.

  • The languages parameter contains an invalid language code2.

Footnotes

  1. The locale language is appended to the list if it is not already part of the list. ↩

  2. A language code is accepted as long as it consists of two lower case ASCII letters. It must not necessarily be defined by ISO 639. ↩