ParametersForGetSearchContextHits (Laserfiche Repository API Client 2.0.3 API)

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

public class ParametersForGetSearchContextHits
extends Object

The encapsulated parameters for getSearchContextHits.

Constructor Summary

Constructors
Constructor and Description

ParametersForGetSearchContextHits()

Constructors
Constructor and Description
`ParametersForGetSearchContextHits()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getOrderby()` Specifies the order in which items are returned.
`String`	`getPrefer()` An optional OData header.
`String`	`getRepoId()` The requested repository ID.
`Integer`	`getRowNumber()` The search result listing row number to get context hits for.
`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.
`ParametersForGetSearchContextHits`	`setCount(Boolean count)` Sets the value of the count parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchContextHits`	`setOrderby(String orderby)` Sets the value of the orderby parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchContextHits`	`setPrefer(String prefer)` Sets the value of the prefer parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchContextHits`	`setRepoId(String repoId)` Sets the value of the repoId parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchContextHits`	`setRowNumber(Integer rowNumber)` Sets the value of the rowNumber parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchContextHits`	`setSearchToken(String searchToken)` Sets the value of the searchToken parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchContextHits`	`setSelect(String select)` Sets the value of the select parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchContextHits`	`setSkip(Integer skip)` Sets the value of the skip parameter and returns the current object, to enable chaining further setters.
`ParametersForGetSearchContextHits`	`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
  - ParametersForGetSearchContextHits
```
public ParametersForGetSearchContextHits()
```
- Method Detail
  - setRepoId
```
public ParametersForGetSearchContextHits 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:
    
    ParametersForGetSearchContextHits The return value
  - getRepoId
```
public String getRepoId()
```
    The requested repository ID.
    
    Returns:
    
    String The return value
  - setSearchToken
```
public ParametersForGetSearchContextHits 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:
    
    ParametersForGetSearchContextHits The return value
  - getSearchToken
```
public String getSearchToken()
```
    The requested searchToken.
    
    Returns:
    
    String The return value
  - setRowNumber
```
public ParametersForGetSearchContextHits setRowNumber(Integer rowNumber)
```
    Sets the value of the rowNumber parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    rowNumber - The search result listing row number to get context hits for.
    
    Returns:
    
    ParametersForGetSearchContextHits The return value
  - getRowNumber
```
public Integer getRowNumber()
```
    The search result listing row number to get context hits for.
    
    Returns:
    
    Integer The return value
  - setPrefer
```
public ParametersForGetSearchContextHits 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:
    
    ParametersForGetSearchContextHits 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
  - setSelect
```
public ParametersForGetSearchContextHits 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:
    
    ParametersForGetSearchContextHits The return value
  - getSelect
```
public String getSelect()
```
    Limits the properties returned in the result.
    
    Returns:
    
    String The return value
  - setOrderby
```
public ParametersForGetSearchContextHits 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:
    
    ParametersForGetSearchContextHits 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 ParametersForGetSearchContextHits 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:
    
    ParametersForGetSearchContextHits The return value
  - getTop
```
public Integer getTop()
```
    Limits the number of items returned from a collection.
    
    Returns:
    
    Integer The return value
  - setSkip
```
public ParametersForGetSearchContextHits 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:
    
    ParametersForGetSearchContextHits 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 ParametersForGetSearchContextHits 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:
    
    ParametersForGetSearchContextHits 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 ParametersForGetSearchContextHits

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParametersForGetSearchContextHits

Method Detail

setRepoId

getRepoId

setSearchToken

getSearchToken

setRowNumber

getRowNumber

setPrefer

getPrefer

setSelect

getSelect

setOrderby

getOrderby

setTop

getTop

setSkip

getSkip

setCount

isCount