IPromptQueryConfig_UserPrompt (formcycle: bom 8.5.6 API)

All Known Implementing Classes:

GenericOaiQueryConfig
```
public interface IPromptQueryConfig_UserPrompt
```
Mixin for a query connection configuration model that allows the user to enter a user prompt message. A user message receives less weight than a system message. Use of this mixin is optional, but ensures a consistent name for the property. When different prompt service handlers use the same property name, switching between different prompt service handlers preserves the configured user prompt.
See also the <xp:userPrompt/> Faces component from the http://www.xima.de/taglib/xfc/prompt namespace, which provides a user interface for editing the data defined by this mixin.

Since:

8.5.0

Field Summary

Fields
Modifier and Type Field Description

static String ATTR_USER_PROMPT
The name of the user prompt attribute.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getUserPrompt()`	Gets the user prompt for the prompt query.
`void`	`setUserPrompt(String userPrompt)`	Sets the user prompt for the prompt query.

- Field Detail
  - ATTR_USER_PROMPT
```
static final String ATTR_USER_PROMPT
```
    The name of the user prompt attribute. If you implement a custom serialization / deserialization, use this name for the attribute to increase compatibility with other prompt service handlers.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getUserPrompt
```
String getUserPrompt()
```
    Gets the user prompt for the prompt query. The user prompt is the message to which the query service should respond.
    
    Returns:
    
    The user prompt.
  - setUserPrompt
```
void setUserPrompt(String userPrompt)
```
    Sets the user prompt for the prompt query. The user prompt is the message to which the query service should respond.
    
    Parameters:
    
    userPrompt - The user prompt to set.