PromptScopeKind (formcycle: bom 8.5.6 API)

java.lang.Object
- java.lang.Enum<PromptScopeKind>
- - de.xima.fc.prompt.mgmt.service.PromptScopeKind

All Implemented Interfaces:

Serializable, Comparable<PromptScopeKind>
```
public enum PromptScopeKind
extends Enum<PromptScopeKind>
```
Enumeration with the possible scoped a prompt object can be assigned to. Each prompt object (connection or query) is assigned to a certain scope. Unless the kind is SYSTEM, the scope is identified by its ID.

Since:

8.5.0

Enum Constant Summary

Enum Constants
Enum Constant	Description
`PROJECT`	The prompt object is assigned to a project.
`SYSTEM`	The prompt object is assigned to the system (global scope)
`TENANT`	The prompt object is assigned to a tenant.

Method Summary

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

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - TENANT
```
public static final PromptScopeKind TENANT
```
    The prompt object is assigned to a tenant.
  - PROJECT
```
public static final PromptScopeKind PROJECT
```
    The prompt object is assigned to a project.
  - SYSTEM
```
public static final PromptScopeKind SYSTEM
```
    The prompt object is assigned to the system (global scope)
- Method Detail
  - values
```
public static PromptScopeKind[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (PromptScopeKind c : PromptScopeKind.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PromptScopeKind 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