Package de.xima.fc.prompt.service.support

Class CommonEffortLevel

java.lang.Object

de.xima.fc.prompt.service.support.CommonEffortLevel

public final class CommonEffortLevel
extends Object

Enumeration for common types of effort levels. The effort level is an optional settings that controls how much effort the model should put into generating a response for the prompt.It is up to implementations to define which effort levels are supported, and what their identifiers are. This class provides standard names of common effort levels. Implementations are encouraged to use these constants to increase interoperability between different prompt service implementations, but are not required to do so.

Since:

8.5.0

See Also:

IPromptQueryConfig_EffortLevel

Field Summary

Fields

Modifier and Type	Field	Description
static String	HIGH	Use a high amount of effort.
static String	LOW	Use only a low amount of effort.
static String	MAXIMUM	Use the maximum amount of effort possible.
static String	MEDIUM	Use a medium amount of effort.
static String	MINIMUM	Use the minimum amount of effort possible.

Method Summary

Modifier and Type	Method	Description
static String	localizedDescription(Locale locale, String commonEffortLevel)	Gets the localized description for the given common effort level.
static String	localizedLabel(Locale locale, String commonEffortLevel)	Gets the localized label for the given common effort level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HIGH

public static final String HIGH

Use a high amount of effort.

See Also:

Constant Field Values

LOW

public static final String LOW

Use only a low amount of effort.

See Also:

Constant Field Values

MAXIMUM

public static final String MAXIMUM

Use the maximum amount of effort possible.

See Also:

Constant Field Values

MEDIUM

public static final String MEDIUM

Use a medium amount of effort.

See Also:

Constant Field Values

MINIMUM

public static final String MINIMUM

Use the minimum amount of effort possible.

See Also:

Constant Field Values

Method Detail

localizedDescription

public static String localizedDescription(Locale locale,
                                          String commonEffortLevel)

Gets the localized description for the given common effort level. The value should be one of the constants defined in this class. When an unknown value is given, returns an implementation-defined default description.

Parameters:

locale - The locale for which to localize the description.

commonEffortLevel - The common effort level constant, must be one of the constants defined in this class.

Returns:

The localized description for the given common effort level.

localizedLabel

public static String localizedLabel(Locale locale,
                                    String commonEffortLevel)

Gets the localized label for the given common effort level. The value should be one of the constants defined in this class. If any other value is given, returns an implementation-defined default label.

Parameters:

locale - The locale for which to localize the label.

commonEffortLevel - The common effort level constant, must be one of the constants defined in this class.

Returns:

The localized label for the given common effort level.