IPromptConnectionConfig_ReadTimeout (formcycle: bom 8.5.6 API)

All Known Implementing Classes:

GenericOaiConnectionConfig
```
public interface IPromptConnectionConfig_ReadTimeout
```
Mixin for a prompt query configuration model that allows the user to configure the read timeout, i.e. the maximum time to wait for the response from the prompt service provider after sending a request. This is different from the connection timeout, which is the maximum time to wait for a connection to be established (before sending the request).
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 data.
See also the <xp:readTimeout/> 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_READ_TIMEOUT
The name of the read timeout attribute.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Duration`	`getReadTimeout()`	Gets the read timeout, i.e. the maximum time to wait for the response from the prompt service provider after sending a request.
`void`	`setReadTimeout(Duration connectionTimeout)`	Sets the read timeout, i.e. the maximum time to wait for the response from the prompt service provider after sending a request.

- Field Detail
  - ATTR_READ_TIMEOUT
```
static final String ATTR_READ_TIMEOUT
```
    The name of the read timeout 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
  - getReadTimeout
```
Duration getReadTimeout()
```
    Gets the read timeout, i.e. the maximum time to wait for the response from the prompt service provider after sending a request.
    
    Returns:
    
    The read timeout.
  - setReadTimeout
```
void setReadTimeout(Duration connectionTimeout)
```
    Sets the read timeout, i.e. the maximum time to wait for the response from the prompt service provider after sending a request.
    
    Parameters:
    
    connectionTimeout - The read timeout to set.