ParametersForCreateSimpleSearchOperation (Laserfiche Repository API Client 2.0.3 API)

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

public class ParametersForCreateSimpleSearchOperation
extends Object

The encapsulated parameters for createSimpleSearchOperation.

Constructor Summary

Constructors
Constructor and Description

ParametersForCreateSimpleSearchOperation()

Constructors
Constructor and Description
`ParametersForCreateSimpleSearchOperation()`

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`	`getRepoId()` The requested repository ID.
`SimpleSearchRequest`	`getRequestBody()`
`String`	`getSelect()` Limits the properties returned in the result.
`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.
`ParametersForCreateSimpleSearchOperation`	`setCount(Boolean count)` Sets the value of the count parameter and returns the current object, to enable chaining further setters.
`ParametersForCreateSimpleSearchOperation`	`setCulture(String culture)` Sets the value of the culture parameter and returns the current object, to enable chaining further setters.
`ParametersForCreateSimpleSearchOperation`	`setFields(String[] fields)` Sets the value of the fields parameter and returns the current object, to enable chaining further setters.
`ParametersForCreateSimpleSearchOperation`	`setFormatFields(Boolean formatFields)` Sets the value of the formatFields parameter and returns the current object, to enable chaining further setters.
`ParametersForCreateSimpleSearchOperation`	`setOrderby(String orderby)` Sets the value of the orderby parameter and returns the current object, to enable chaining further setters.
`ParametersForCreateSimpleSearchOperation`	`setRepoId(String repoId)` Sets the value of the repoId parameter and returns the current object, to enable chaining further setters.
`ParametersForCreateSimpleSearchOperation`	`setRequestBody(SimpleSearchRequest requestBody)`
`ParametersForCreateSimpleSearchOperation`	`setSelect(String select)` Sets the value of the select 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
  - ParametersForCreateSimpleSearchOperation
```
public ParametersForCreateSimpleSearchOperation()
```
- Method Detail
  - setSelect
```
public ParametersForCreateSimpleSearchOperation 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:
    
    ParametersForCreateSimpleSearchOperation The return value
  - getSelect
```
public String getSelect()
```
    Limits the properties returned in the result.
    
    Returns:
    
    String The return value
  - setOrderby
```
public ParametersForCreateSimpleSearchOperation 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:
    
    ParametersForCreateSimpleSearchOperation 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
  - setCount
```
public ParametersForCreateSimpleSearchOperation 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:
    
    ParametersForCreateSimpleSearchOperation 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
  - setRepoId
```
public ParametersForCreateSimpleSearchOperation 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:
    
    ParametersForCreateSimpleSearchOperation The return value
  - getRepoId
```
public String getRepoId()
```
    The requested repository ID.
    
    Returns:
    
    String The return value
  - setFields
```
public ParametersForCreateSimpleSearchOperation 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:
    
    ParametersForCreateSimpleSearchOperation 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 ParametersForCreateSimpleSearchOperation 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:
    
    ParametersForCreateSimpleSearchOperation 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
  - setRequestBody
```
public ParametersForCreateSimpleSearchOperation setRequestBody(SimpleSearchRequest requestBody)
```
  - getRequestBody
```
public SimpleSearchRequest getRequestBody()
```
  - setCulture
```
public ParametersForCreateSimpleSearchOperation 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:
    
    ParametersForCreateSimpleSearchOperation 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

Class ParametersForCreateSimpleSearchOperation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParametersForCreateSimpleSearchOperation

Method Detail

setSelect

getSelect

setOrderby

getOrderby

setCount

isCount

setRepoId

getRepoId

setFields

getFields

setFormatFields

isFormatFields

setRequestBody

getRequestBody

setCulture

getCulture