ParametersForGetSearchResults (Laserfiche Repository API Client 2.0.3 API)

java.lang.Object
- com.laserfiche.repository.api.clients.params.ParametersForGetSearchResults

public class ParametersForGetSearchResults
extends Object

The encapsulated parameters for getSearchResults.

Constructor Summary

Constructors
Constructor and Description

ParametersForGetSearchResults()

Constructors
Constructor and Description
`ParametersForGetSearchResults()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getCulture()` An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
`String[]`	`getFields()` Optional array of field names.
`String`	`getOrderby()` Specifies the order in which items are returned.
`String`	`getPrefer()` An optional odata header.
`String`	`getRepoId()` The requested repository ID.
`String`	`getSearchToken()` The requested searchToken.
`String`	`getSelect()` Limits the properties returned in the result.
`Integer`	`getSkip()` Excludes the specified number of items of the queried collection from the result.
`Integer`	`getTop()` Limits the number of items returned from a collection.
`Boolean`	`isCount()` Indicates whether the total count of items within a collection are returned in the result.
`Boolean`	`isFormatFields()` Boolean for if field values should be formatted.
`Boolean`	`isGroupByEntryType()` An optional query parameter used to indicate if the result should be grouped by entry type or not.
`Boolean`	`isRefresh()` If the search listing should be refreshed to show updated values.
`ParametersForGetSearchResults`	`setCount(Boolean count)` Sets the value of the count parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchResults`	`setCulture(String culture)` Sets the value of the culture parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchResults`	`setFields(String[] fields)` Sets the value of the fields parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchResults`	`setFormatFields(Boolean formatFields)` Sets the value of the formatFields parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchResults`	`setGroupByEntryType(Boolean groupByEntryType)` Sets the value of the groupByEntryType parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchResults`	`setOrderby(String orderby)` Sets the value of the orderby parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchResults`	`setPrefer(String prefer)` Sets the value of the prefer parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchResults`	`setRefresh(Boolean refresh)` Sets the value of the refresh parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchResults`	`setRepoId(String repoId)` Sets the value of the repoId parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchResults`	`setSearchToken(String searchToken)` Sets the value of the searchToken parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchResults`	`setSelect(String select)` Sets the value of the select parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchResults`	`setSkip(Integer skip)` Sets the value of the skip parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchResults`	`setTop(Integer top)` Sets the value of the top parameter and returns the current object, to enable chaining further setters.

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

- Constructor Detail
  - ParametersForGetSearchResults
```
public ParametersForGetSearchResults()
```
- Method Detail
  - setRepoId
```
public ParametersForGetSearchResults setRepoId(String repoId)
```
    Sets the value of the repoId parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    repoId - The requested repository ID.
    
    Returns:
    
    ParametersForGetSearchResults The return value
  - getRepoId
```
public String getRepoId()
```
    The requested repository ID.
    
    Returns:
    
    String The return value
  - setSearchToken
```
public ParametersForGetSearchResults setSearchToken(String searchToken)
```
    Sets the value of the searchToken parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    searchToken - The requested searchToken.
    
    Returns:
    
    ParametersForGetSearchResults The return value
  - getSearchToken
```
public String getSearchToken()
```
    The requested searchToken.
    
    Returns:
    
    String The return value
  - setGroupByEntryType
```
public ParametersForGetSearchResults setGroupByEntryType(Boolean groupByEntryType)
```
    Sets the value of the groupByEntryType parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    groupByEntryType - An optional query parameter used to indicate if the result should be grouped by entry type or not.
    
    Returns:
    
    ParametersForGetSearchResults The return value
  - isGroupByEntryType
```
public Boolean isGroupByEntryType()
```
    An optional query parameter used to indicate if the result should be grouped by entry type or not.
    
    Returns:
    
    Boolean The return value
  - setRefresh
```
public ParametersForGetSearchResults setRefresh(Boolean refresh)
```
    Sets the value of the refresh parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    refresh - If the search listing should be refreshed to show updated values.
    
    Returns:
    
    ParametersForGetSearchResults The return value
  - isRefresh
```
public Boolean isRefresh()
```
    If the search listing should be refreshed to show updated values.
    
    Returns:
    
    Boolean The return value
  - setFields
```
public ParametersForGetSearchResults setFields(String[] fields)
```
    Sets the value of the fields parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    fields - Optional array of field names. Field values corresponding to the given field names will be returned for each search result.
    
    Returns:
    
    ParametersForGetSearchResults The return value
  - getFields
```
public String[] getFields()
```
    Optional array of field names. Field values corresponding to the given field names will be returned for each search result.
    
    Returns:
    
    String[] The return value
  - setFormatFields
```
public ParametersForGetSearchResults setFormatFields(Boolean formatFields)
```
    Sets the value of the formatFields parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    formatFields - Boolean for if field values should be formatted. Only applicable if Fields are specified.
    
    Returns:
    
    ParametersForGetSearchResults The return value
  - isFormatFields
```
public Boolean isFormatFields()
```
    Boolean for if field values should be formatted. Only applicable if Fields are specified.
    
    Returns:
    
    Boolean The return value
  - setPrefer
```
public ParametersForGetSearchResults setPrefer(String prefer)
```
    Sets the value of the prefer parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    prefer - An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.
    
    Returns:
    
    ParametersForGetSearchResults The return value
  - getPrefer
```
public String getPrefer()
```
    An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.
    
    Returns:
    
    String The return value
  - setCulture
```
public ParametersForGetSearchResults setCulture(String culture)
```
    Sets the value of the culture parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting.
    
    Returns:
    
    ParametersForGetSearchResults The return value
  - getCulture
```
public String getCulture()
```
    An optional query parameter used to indicate the locale that should be used for formatting.
    The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise
    culture will not be used for formatting.
    
    Returns:
    
    String The return value
  - setSelect
```
public ParametersForGetSearchResults setSelect(String select)
```
    Sets the value of the select parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    select - Limits the properties returned in the result.
    
    Returns:
    
    ParametersForGetSearchResults The return value
  - getSelect
```
public String getSelect()
```
    Limits the properties returned in the result.
    
    Returns:
    
    String The return value
  - setOrderby
```
public ParametersForGetSearchResults setOrderby(String orderby)
```
    Sets the value of the orderby parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.
    
    Returns:
    
    ParametersForGetSearchResults The return value
  - getOrderby
```
public String getOrderby()
```
    Specifies the order in which items are returned. The maximum number of expressions is 5.
    
    Returns:
    
    String The return value
  - setTop
```
public ParametersForGetSearchResults setTop(Integer top)
```
    Sets the value of the top parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    top - Limits the number of items returned from a collection.
    
    Returns:
    
    ParametersForGetSearchResults The return value
  - getTop
```
public Integer getTop()
```
    Limits the number of items returned from a collection.
    
    Returns:
    
    Integer The return value
  - setSkip
```
public ParametersForGetSearchResults setSkip(Integer skip)
```
    Sets the value of the skip parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    skip - Excludes the specified number of items of the queried collection from the result.
    
    Returns:
    
    ParametersForGetSearchResults The return value
  - getSkip
```
public Integer getSkip()
```
    Excludes the specified number of items of the queried collection from the result.
    
    Returns:
    
    Integer The return value
  - setCount
```
public ParametersForGetSearchResults setCount(Boolean count)
```
    Sets the value of the count parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    count - Indicates whether the total count of items within a collection are returned in the result.
    
    Returns:
    
    ParametersForGetSearchResults The return value
  - isCount
```
public Boolean isCount()
```
    Indicates whether the total count of items within a collection are returned in the result.
    
    Returns:
    
    Boolean The return value

Class ParametersForGetSearchResults

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParametersForGetSearchResults

Method Detail

setRepoId

getRepoId

setSearchToken

getSearchToken

setGroupByEntryType

isGroupByEntryType

setRefresh

isRefresh

setFields

getFields

setFormatFields

isFormatFields

setPrefer

getPrefer

setCulture

getCulture

setSelect

getSelect

setOrderby

getOrderby

setTop

getTop

setSkip

getSkip

setCount

isCount