PromptQueryData (formcycle: bom 8.5.6 API)

java.lang.Object
- de.xima.fc.prompt.mgmt.service.PromptQueryData

All Implemented Interfaces:: Serializable

public final class PromptQueryData
extends Object
implements Serializable

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PromptQueryData.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PromptQueryData.Builder`	`builder()`	Creates a new builder for `PromptQueryData`.
`PromptObjectIdentifier`	`connection()`	Gets the prompt connection used by this query.
`static PromptQueryData.Builder`	`derive(PromptQueryData data)`	Creates a new builder pre-configured with the data of the given instance.
`String`	`description()`	Gets the internal description of the prompt query.
`String`	`name()`	Gets the name of the prompt query.
`PromptScope`	`scope()`	Gets the scope (assignee) of the prompt query.
`UUID`	`uuid()`	Gets the UUID of the prompt query.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - scope
```
public PromptScope scope()
```
    Gets the scope (assignee) of the prompt query. Defines the scope to which the query is assigned, e.g. the system or a tenant scope.
    
    Returns:
    
    The scope.
  - connection
```
public PromptObjectIdentifier connection()
```
    Gets the prompt connection used by this query.
    
    Returns:
    
    The prompt connection.
  - description
```
public String description()
```
    Gets the internal description of the prompt query. The description should only be visible to backend users who configure the query, but not to end users.
    
    Returns:
    
    The description of the prompt query.
  - name
```
public String name()
```
    Gets the name of the prompt query. The name is unique with the scope to which the query is assigned.
    
    Returns:
    
    The name of the prompt query.
  - uuid
```
public UUID uuid()
```
    Gets the UUID of the prompt query. The UUID is unique only within the assigned scope.
    
    Returns:
    
    The UUID.
  - builder
```
public static PromptQueryData.Builder builder()
```
    Creates a new builder for PromptQueryData.
    
    Returns:
    
    A new builder.
  - derive
```
public static PromptQueryData.Builder derive(PromptQueryData data)
```
    Creates a new builder pre-configured with the data of the given instance.
    
    Parameters:
    
    data - The instance to copy data from.
    
    Returns:
    
    A new builder.