ParametersForGetFieldValues (Laserfiche Repository API Client 2.0.3 API)

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

public class ParametersForGetFieldValues
extends Object

The encapsulated parameters for getFieldValues.

Constructor Summary

Constructors
Constructor and Description

ParametersForGetFieldValues()

Constructors
Constructor and Description
`ParametersForGetFieldValues()`

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.
`Integer`	`getEntryId()` The requested entry ID.
`String`	`getOrderby()` Specifies the order in which items are returned.
`String`	`getPrefer()` An optional OData header.
`String`	`getRepoId()` The requested repository ID.
`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`	`isFormatValue()` An optional query parameter used to indicate if the field values should be formatted. The default value is false.
`ParametersForGetFieldValues`	`setCount(Boolean count)` Sets the value of the count parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldValues`	`setCulture(String culture)` Sets the value of the culture parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldValues`	`setEntryId(Integer entryId)` Sets the value of the entryId parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldValues`	`setFormatValue(Boolean formatValue)` Sets the value of the formatValue parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldValues`	`setOrderby(String orderby)` Sets the value of the orderby parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldValues`	`setPrefer(String prefer)` Sets the value of the prefer parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldValues`	`setRepoId(String repoId)` Sets the value of the repoId parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldValues`	`setSelect(String select)` Sets the value of the select parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldValues`	`setSkip(Integer skip)` Sets the value of the skip parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldValues`	`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
  - ParametersForGetFieldValues
```
public ParametersForGetFieldValues()
```
- Method Detail
  - setRepoId
```
public ParametersForGetFieldValues 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:
    
    ParametersForGetFieldValues The return value
  - getRepoId
```
public String getRepoId()
```
    The requested repository ID.
    
    Returns:
    
    String The return value
  - setEntryId
```
public ParametersForGetFieldValues setEntryId(Integer entryId)
```
    Sets the value of the entryId parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    entryId - The requested entry ID.
    
    Returns:
    
    ParametersForGetFieldValues The return value
  - getEntryId
```
public Integer getEntryId()
```
    The requested entry ID.
    
    Returns:
    
    Integer The return value
  - setPrefer
```
public ParametersForGetFieldValues 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:
    
    ParametersForGetFieldValues 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
  - setFormatValue
```
public ParametersForGetFieldValues setFormatValue(Boolean formatValue)
```
    Sets the value of the formatValue parameter and returns the current object, to enable chaining further setters.
    
    Parameters:
    
    formatValue - An optional query parameter used to indicate if the field values should be formatted. The default value is false.
    
    Returns:
    
    ParametersForGetFieldValues The return value
  - isFormatValue
```
public Boolean isFormatValue()
```
    An optional query parameter used to indicate if the field values should be formatted.
    The default value is false.
    
    Returns:
    
    Boolean The return value
  - setCulture
```
public ParametersForGetFieldValues 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 formatValue query parameter must be set to true, otherwise culture will not be used for formatting.
    
    Returns:
    
    ParametersForGetFieldValues 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 formatValue query parameter must be set to true, otherwise
    culture will not be used for formatting.
    
    Returns:
    
    String The return value
  - setSelect
```
public ParametersForGetFieldValues 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:
    
    ParametersForGetFieldValues The return value
  - getSelect
```
public String getSelect()
```
    Limits the properties returned in the result.
    
    Returns:
    
    String The return value
  - setOrderby
```
public ParametersForGetFieldValues 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:
    
    ParametersForGetFieldValues 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 ParametersForGetFieldValues 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:
    
    ParametersForGetFieldValues The return value
  - getTop
```
public Integer getTop()
```
    Limits the number of items returned from a collection.
    
    Returns:
    
    Integer The return value
  - setSkip
```
public ParametersForGetFieldValues 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:
    
    ParametersForGetFieldValues 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 ParametersForGetFieldValues 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:
    
    ParametersForGetFieldValues 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 ParametersForGetFieldValues

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParametersForGetFieldValues

Method Detail

setRepoId

getRepoId

setEntryId

getEntryId

setPrefer

getPrefer

setFormatValue

isFormatValue

setCulture

getCulture

setSelect

getSelect

setOrderby

getOrderby

setTop

getTop

setSkip

getSkip

setCount

isCount