com.businessobjects.rebean.wi
Class DocumentLocaleType

java.lang.Object
  com.businessobjects.rebean.wi.DocumentLocaleType

public class DocumentLocaleType
extends java.lang.Object

The DocumentLocaleType class is used to control the locale in which DocumentInstance data is formatted.

In Web Intelligence, a user can differentiate between the language the user interface is displayed and the language in which DocumentInstance data is displayed. These locales are known as the User Interface Language (UIL) and the User Formatting Locale (UFL).
The UIL is the language in which the InfoView is presented, that is to say the menus, messages, etc. The UIL is a localized language added when Business Objects Enterprise was installed.
The UFL is the setting chosen by a user as the default locale used to format data when creating or opening a Web Intelligence document. By default the UFL is the same as the UIL; this can be changed using the Web Intelligence Document Preferences tab in the InfoView personalization page.

A DocumentInstance object contains a DocumentLocaleType instance. Depending on the setting of DocumentLocaleType, when a DocumentInstance is opened, its data is formatted using either the document authors UFL, or the document openers UFL.

Note: Different data formats can result in documents having a different aspect.

Note: Lov display and Prompt entry is always done in current users UFL.

Since:

11.5

See Also:

DocumentInstance.getFormattingLocale(), DocumentInstance.setFormattingLocale(com.businessobjects.rebean.wi.DocumentLocaleType)

Field Summary

static int	_BASELOCALE Represents the int value correspnding to BASELOCALE type.
static int	_LOCALE Represents the int value correspnding to LOCALE type.
static DocumentLocaleType	BASELOCALE DocumentInstance data is displayed using the document authors User Formatting Locale (UFL).
static DocumentLocaleType	LOCALE DocumentInstance data is displayed using the current users User Formatting Locale (UFL).

Method Summary

static DocumentLocaleType	from_int(int value) Return a DocumentLocaleType corresponding to a specific int value.
java.lang.String	toString() Return a String representation of the DocumentLocaleType instance.
int	value() The int value of this DocumentLocaleType instance.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_LOCALE

public static final int _LOCALE

Represents the int value correspnding to LOCALE type.

See Also:

Constant Field Values

LOCALE

public static final DocumentLocaleType LOCALE

DocumentInstance data is displayed using the current users User Formatting Locale (UFL).

_BASELOCALE

public static final int _BASELOCALE

Represents the int value correspnding to BASELOCALE type.

See Also:

Constant Field Values

BASELOCALE

public static final DocumentLocaleType BASELOCALE

DocumentInstance data is displayed using the document authors User Formatting Locale (UFL).

Method Detail

value

public int value()

The int value of this DocumentLocaleType instance.

Returns:

The int value of this DocumentLocaleType instance.

from_int

public static DocumentLocaleType from_int(int value)

Return a DocumentLocaleType corresponding to a specific int value.

Parameters:

value - The type of DocumentLocaleType required.

Returns:

Return a DocumentLocaleType corresponding to a specific int value.

toString

public java.lang.String toString()

Return a String representation of the DocumentLocaleType instance.

Overrides:

toString in class java.lang.Object

Returns:

A String representation of the DocumentLocaleType instance.