Enum PromptScopeResolutionMode

java.lang.Object

java.lang.Enum<PromptScopeResolutionMode>

de.xima.fc.prompt.mgmt.service.PromptScopeResolutionMode

All Implemented Interfaces:

Serializable, Comparable<PromptScopeResolutionMode>

public enum PromptScopeResolutionMode
extends Enum<PromptScopeResolutionMode>

Defines how to resolve prompt scopes. E.g. when a scope is given, such as a tenant scope, this controls whether the result is limited to that tenant scope, or result from the system scope are included as well.

Since:

8.5.0

Author:

XIMA MEDIA GmbH

See Also:

• PromptScopeKind

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHILDREN_AND_SELF	Also include result from child scopes as well.
PARENTS_AND_SELF	Also include result from parent scopes as well.
SELF	Limit the result to the given scope only.

Method Summary

Modifier and Type	Method	Description
static PromptScopeResolutionMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PromptScopeResolutionMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PARENTS_AND_SELF

public static final PromptScopeResolutionMode PARENTS_AND_SELF

Also include result from parent scopes as well. For example, when the scope is tenant, also finds results from the parent system scope.

CHILDREN_AND_SELF

public static final PromptScopeResolutionMode CHILDREN_AND_SELF

Also include result from child scopes as well. For example, when the scope is tenant, also finds results from all project scopes within that tenant.

SELF

public static final PromptScopeResolutionMode SELF

Limit the result to the given scope only.

Method Details

values

public static PromptScopeResolutionMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PromptScopeResolutionMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null