SearchRequestParams (biocache-hubs 2.1.9 API)

au.org.ala.biocache.hubs.SearchRequestParams

All Implemented Interfaces and Traits:

grails.validation.Validateable
```
@groovy.util.logging.Slf4j
class SearchRequestParams
extends java.lang.Object
```
Data Transfer Object to represent the request parameters required to search for occurrence records against biocache-service.
Authors:
"Nick dos Remedios "

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`dir`
`java.lang.String`	`displayString`
`java.lang.Boolean`	`facet` To disable facets
`java.lang.String[]`	`facets` The facets to be included by the search Initialised with the default facets to use
`java.lang.String`	`fl`
`java.lang.Integer`	`flimit` The limit for the number of facets to return
`java.lang.Integer`	`foffset` The offset of facets to return.
`java.lang.String`	`formattedQuery`
`java.lang.String`	`fprefix` The prefix to limit facet values
`java.lang.String[]`	`fq`
`java.lang.String`	`fsort` The sort order in which to return the facets.
`java.lang.Integer`	`max`
`java.lang.Integer`	`offset`
`java.lang.String`	`order`
`java.lang.Integer`	`pageSize`
`java.lang.String`	`q`
`java.lang.Long`	`qId`
`java.lang.String`	`qc` The query context to be used for the search.
`java.lang.String`	`sort`
`java.lang.Integer`	`start` pagination params

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`conditionalEncode(java.lang.String input, java.lang.Boolean isEncoded)` URI encode the param value if isEncoded is true
	`java.lang.String`	`getEncodedParams()` Produce a URI encoded query string for use in java.util.URI, etc
	`java.lang.String`	`getUrlParams()` Constructs the params to be returned in the result
	`java.lang.String`	`toString()` Custom toString method to produce a String to be used as the request parameters for the Biocache Service webservices
	`java.lang.String`	`toString(java.lang.Boolean encodeParams)` Common code to output a param string with conditional encoding of values

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - java.lang.String dir
  - java.lang.String displayString
  - java.lang.Boolean facet
    
    To disable facets
  - java.lang.String[] facets
    
    The facets to be included by the search Initialised with the default facets to use
  - java.lang.String fl
  - java.lang.Integer flimit
    
    The limit for the number of facets to return
  - java.lang.Integer foffset
    
    The offset of facets to return. Used in conjunction to flimit
  - java.lang.String formattedQuery
  - java.lang.String fprefix
    
    The prefix to limit facet values
  - java.lang.String[] fq
  - java.lang.String fsort
    
    The sort order in which to return the facets. Either count or index. When empty string the default values are used as defined in the Theme based facets
  - java.lang.Integer max
  - java.lang.Integer offset
  - java.lang.String order
  - java.lang.Integer pageSize
  - java.lang.String q
  - java.lang.Long qId
  - java.lang.String qc
    
    The query context to be used for the search. This will be used to generate extra query filters based on the search technology
  - java.lang.String sort
  - java.lang.Integer start
    
    pagination params
- Method Detail
  - java.lang.String conditionalEncode(java.lang.String input, java.lang.Boolean isEncoded)
    
    URI encode the param value if isEncoded is true
    Parameters:
    input
    isEncoded
    Returns:
    query string
  - java.lang.String getEncodedParams()
    
    Produce a URI encoded query string for use in java.util.URI, etc
    Returns:
    encoded query string
  - java.lang.String getUrlParams()
    
    Constructs the params to be returned in the result
    Returns:
    req
  - @java.lang.Override java.lang.String toString()
    
    Custom toString method to produce a String to be used as the request parameters for the Biocache Service webservices
    Returns:
    request parameters string
  - java.lang.String toString(java.lang.Boolean encodeParams)
    
    Common code to output a param string with conditional encoding of values
    Parameters:
    encodeParams
    Returns:
    query string

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class SearchRequestParams

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String dir

java.lang.String displayString

java.lang.Boolean facet

java.lang.String[] facets

java.lang.String fl

java.lang.Integer flimit

java.lang.Integer foffset

java.lang.String formattedQuery

java.lang.String fprefix

java.lang.String[] fq

java.lang.String fsort

java.lang.Integer max

java.lang.Integer offset

java.lang.String order

java.lang.Integer pageSize

java.lang.String q

java.lang.Long qId

java.lang.String qc

java.lang.String sort

java.lang.Integer start

Method Detail

java.lang.String conditionalEncode(java.lang.String input, java.lang.Boolean isEncoded)

java.lang.String getEncodedParams()

java.lang.String getUrlParams()

@java.lang.Override java.lang.String toString()

java.lang.String toString(java.lang.Boolean encodeParams)