java.lang.Object
- com.funnelback.publicui.search.model.transaction.SearchQuestion.RequestParameters

Enclosing class:

SearchQuestion
```
public static class SearchQuestion.RequestParameters
extends Object
```
Common query string parameters names.

Since:

11.0

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SearchQuestion.RequestParameters.Cache`	Common request parameter names used in the cache controller.
`static class`	`SearchQuestion.RequestParameters.Cart`	Common request parameters used in the ResultsCartController
`static class`	`SearchQuestion.RequestParameters.Click`	Common request parameter names used in the click controller.
`static class`	`SearchQuestion.RequestParameters.ContextualNavigation`	Common request parameter names used in contextual navigation.
`static class`	`SearchQuestion.RequestParameters.Header`	Common request header names
`static class`	`SearchQuestion.RequestParameters.Serve`	Common request parameter names used in the `serve-*` controllers

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`CLIVE`	Meta components restriction
`static String`	`COLLAPSING`	Controls whether or not result collapsing is performed
`static String`	`COLLAPSING_SIGNATURE`	Controls the field used for collapsing
`static String`	`COLLECTION`	Collection ID
`static String`	`CONTENT_OPTIMISER_ADVANCED`	Content Optimiser: Advanced mode toggle.
`static String`	`CONTENT_OPTIMISER_URL`	Content Optimiser: URL of the document to optimise.
`static String`	`CURATOR`	Parameter for enabling/disabling curator
`static String`	`DAAT`	Parameter for controlling the number of documents considered in document at a time mode
`static String`	`DEBUG`	PADRE debug mode
`static String`	`ENC`	Encoding of the input parameters (query ...)
`static String`	`EXP`	Explore: Number of query terms
`static String`	`EXPLAIN`	Content Optimiser: Activate explain mode on PADRE.
`static Pattern`	`FACET_PARAM_PATTERN`	Pattern to use to find faceted navigation parameters.
`static String`	`FACET_PREFIX`	Prefix used on faceted navigation parameters (Ex: `f.Location\|X=...`
`static String`	`FACET_SCOPE`	Checkbox used to preserve the facet scope when running a query.
`static String`	`FORM`	Name of the form (template) to use to display results
`static String`	`FULL_MATCHES_ONLY`	Parameter indicating only fully matching documents should be returned
`static String`	`GSCOPE1`	Gscope constraint
`static String`	`LANG`	Parameter to specify the locale of the search query
`static String`	`LANG_UI`	Parameter to specify the locale of the UI only
`static String`	`METADATA_BUFFER_LENGTH`	Maximum bytes of metadata to return per result
`static String`	`NUM_RANKS`	Number of results per page
`static String`	`ONESHOT`	Special parameter to redirect directly to the first result
`static String`	`ORIGIN`	Parameter specifying the origin point for the search request
`static String`	`PROFILE`	Search profile
`static String`	`PROMOTE_URLS`	Parameter for promoting individual URLs
`static String`	`QUERY`	Query terms
`static String`	`REMOVE_URLS`	Parameter for removing individual URLs
`static String`	`S`	System generated query
`static String`	`START_RANK`	Rank of the first result to display
`static String`	`STEM`	Controls the type/level of stemming which should be used
`static String`	`SUMMARY_FIELDS`	Metadata field list to be used in producing result metadata summaries
`static String`	`SUMMARY_MODE`	Type of result summaries padre should return

Constructor Summary

Constructors
Constructor Description

RequestParameters()

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

- Field Detail
  - COLLECTION
```
public static final String COLLECTION
```
    Collection ID
    
    See Also:
    
    Constant Field Values
  - QUERY
```
public static final String QUERY
```
    Query terms
    
    See Also:
    
    Constant Field Values
  - S
```
public static final String S
```
    System generated query
    
    See Also:
    
    Constant Field Values
  - PROFILE
```
public static final String PROFILE
```
    Search profile
    
    See Also:
    
    Constant Field Values
  - CLIVE
```
public static final String CLIVE
```
    Meta components restriction
    
    See Also:
    
    Constant Field Values
  - GSCOPE1
```
public static final String GSCOPE1
```
    Gscope constraint
    
    See Also:
    
    Constant Field Values
  - FORM
```
public static final String FORM
```
    Name of the form (template) to use to display results
    
    See Also:
    
    Constant Field Values
  - NUM_RANKS
```
public static final String NUM_RANKS
```
    Number of results per page
    
    See Also:
    
    Constant Field Values
  - START_RANK
```
public static final String START_RANK
```
    Rank of the first result to display
    
    See Also:
    
    Constant Field Values
  - EXP
```
public static final String EXP
```
    Explore: Number of query terms
    
    See Also:
    
    Constant Field Values
  - FACET_PREFIX
```
public static final String FACET_PREFIX
```
    Prefix used on faceted navigation parameters (Ex: f.Location|X=...
    
    See Also:
    
    Constant Field Values
  - FACET_SCOPE
```
public static final String FACET_SCOPE
```
    Checkbox used to preserve the facet scope when running a query.
    
    See Also:
    
    Constant Field Values
  - FACET_PARAM_PATTERN
```
public static final Pattern FACET_PARAM_PATTERN
```
    Pattern to use to find faceted navigation parameters.
  - CONTENT_OPTIMISER_URL
```
public static final String CONTENT_OPTIMISER_URL
```
    Content Optimiser: URL of the document to optimise.
    
    See Also:
    
    Constant Field Values
  - CONTENT_OPTIMISER_ADVANCED
```
public static final String CONTENT_OPTIMISER_ADVANCED
```
    Content Optimiser: Advanced mode toggle.
    
    See Also:
    
    Constant Field Values
  - EXPLAIN
```
public static final String EXPLAIN
```
    Content Optimiser: Activate explain mode on PADRE.
    
    See Also:
    
    Constant Field Values
  - ONESHOT
```
public static final String ONESHOT
```
    Special parameter to redirect directly to the first result
    
    See Also:
    
    Constant Field Values
  - ENC
```
public static final String ENC
```
    Encoding of the input parameters (query ...)
    
    See Also:
    
    Constant Field Values
  - LANG
```
public static final String LANG
```
    Parameter to specify the locale of the search query
    
    Will affect the UI as well as the query processor.
    
    See Also:
    
    Constant Field Values
  - LANG_UI
```
public static final String LANG_UI
```
    Parameter to specify the locale of the UI only
    
    See Also:
    
    Constant Field Values
  - ORIGIN
```
public static final String ORIGIN
```
    Parameter specifying the origin point for the search request
    
    See Also:
    
    Constant Field Values
  - DEBUG
```
public static final String DEBUG
```
    PADRE debug mode
    
    See Also:
    
    Constant Field Values
  - PROMOTE_URLS
```
public static final String PROMOTE_URLS
```
    Parameter for promoting individual URLs
    
    See Also:
    
    Constant Field Values
  - REMOVE_URLS
```
public static final String REMOVE_URLS
```
    Parameter for removing individual URLs
    
    See Also:
    
    Constant Field Values
  - CURATOR
```
public static final String CURATOR
```
    Parameter for enabling/disabling curator
    
    See Also:
    
    Constant Field Values
  - DAAT
```
public static final String DAAT
```
    Parameter for controlling the number of documents considered in document at a time mode
    
    See Also:
    
    Constant Field Values
  - FULL_MATCHES_ONLY
```
public static final String FULL_MATCHES_ONLY
```
    Parameter indicating only fully matching documents should be returned
    
    See Also:
    
    Constant Field Values
  - METADATA_BUFFER_LENGTH
```
public static final String METADATA_BUFFER_LENGTH
```
    Maximum bytes of metadata to return per result
    
    See Also:
    
    Constant Field Values
  - SUMMARY_MODE
```
public static final String SUMMARY_MODE
```
    Type of result summaries padre should return
    
    See Also:
    
    Constant Field Values
  - SUMMARY_FIELDS
```
public static final String SUMMARY_FIELDS
```
    Metadata field list to be used in producing result metadata summaries
    
    See Also:
    
    Constant Field Values
  - STEM
```
public static String STEM
```
    Controls the type/level of stemming which should be used
  - COLLAPSING
```
public static String COLLAPSING
```
    Controls whether or not result collapsing is performed
  - COLLAPSING_SIGNATURE
```
public static String COLLAPSING_SIGNATURE
```
    Controls the field used for collapsing
- Constructor Detail
  - RequestParameters
```
public RequestParameters()
```

Class SearchQuestion.RequestParameters

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COLLECTION

QUERY

S

PROFILE

CLIVE

GSCOPE1

FORM

NUM_RANKS

START_RANK

EXP

FACET_PREFIX

FACET_SCOPE

FACET_PARAM_PATTERN

CONTENT_OPTIMISER_URL

CONTENT_OPTIMISER_ADVANCED

EXPLAIN

ONESHOT

ENC

LANG

LANG_UI

ORIGIN

DEBUG

PROMOTE_URLS

REMOVE_URLS

CURATOR

DAAT

FULL_MATCHES_ONLY

METADATA_BUFFER_LENGTH

SUMMARY_MODE

SUMMARY_FIELDS

STEM

COLLAPSING

COLLAPSING_SIGNATURE

Constructor Detail

RequestParameters