CacheQuestion (Plugin Shared 16.32.0-SNAPSHOT API)

java.lang.Object
- com.funnelback.publicui.search.model.transaction.cache.CacheQuestion

```
public class CacheQuestion
extends Object
```
This class contains all the input parameters for a cache request

Since:

15.0

Field Summary

Fields
Modifier and Type	Field	Description
`private @NonNull SearchPackageConfig`	`collection`	`Collection` to get the cached document from
`private String`	`doc`	Relative path of the document in the collection storage to access the document.
`private @NonNull @Pattern(regexp="[\\w-_]+") String`	`form`	Form (template) to use to render the cached copy
`private int`	`len`	Length of the document in the WARC file
`private long`	`off`	Offset of the document in the WARC file
`private @NonNull @Pattern(regexp="[\\w-_]+") String`	`profile`	Profile where to lookup the cached copies template to use
`private String`	`url`	URL of the document to retrieve the cached copy of

Constructor Summary

Constructors
Constructor Description

CacheQuestion()

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

- Field Detail
  - collection
```
@NonNull
private @NonNull SearchPackageConfig collection
```
    Collection to get the cached document from
  - profile
```
@NonNull
@Pattern(regexp="[\\w-_]+")
private @NonNull @Pattern(regexp="[\\w-_]+") String profile
```
    Profile where to lookup the cached copies template to use
  - form
```
@NonNull
@Pattern(regexp="[\\w-_]+")
private @NonNull @Pattern(regexp="[\\w-_]+") String form
```
    Form (template) to use to render the cached copy
    
    The template is expected to be prefixed with cache. and have the extension .ftl
  - url
```
private String url
```
    URL of the document to retrieve the cached copy of
  - doc
```
private String doc
```
    Relative path of the document in the collection storage to access the document.
    
    This is used as a fallback method if the document cannot be found via its URL, for example if the URL has been rewritten
  - off
```
private long off
```
    Offset of the document in the WARC file
  - len
```
private int len
```
    Length of the document in the WARC file
- Constructor Detail
  - CacheQuestion
```
public CacheQuestion()
```