ParametersForGetFieldDefinitions (Laserfiche Repository API Client 2.0.3 API)

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

public class ParametersForGetFieldDefinitions
extends Object

The encapsulated parameters for getFieldDefinitions.

Constructor Summary

Constructors
Constructor and Description

ParametersForGetFieldDefinitions()

Constructors
Constructor and Description
`ParametersForGetFieldDefinitions()`

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`	`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.
`ParametersForGetFieldDefinitions`	`setCount(Boolean count)` Sets the value of the count parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldDefinitions`	`setCulture(String culture)` Sets the value of the culture parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldDefinitions`	`setOrderby(String orderby)` Sets the value of the orderby parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldDefinitions`	`setPrefer(String prefer)` Sets the value of the prefer parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldDefinitions`	`setRepoId(String repoId)` Sets the value of the repoId parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldDefinitions`	`setSelect(String select)` Sets the value of the select parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldDefinitions`	`setSkip(Integer skip)` Sets the value of the skip parameter and returns the current object, to enable chaining further setters.
`ParametersForGetFieldDefinitions`	`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
  - ParametersForGetFieldDefinitions
```
public ParametersForGetFieldDefinitions()
```
- Method Detail
  - setRepoId
```
public ParametersForGetFieldDefinitions 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:
    
    ParametersForGetFieldDefinitions The return value
  - getRepoId
```
public String getRepoId()
```
    The requested repository ID.
    
    Returns:
    
    String The return value
  - setPrefer
```
public ParametersForGetFieldDefinitions 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:
    
    ParametersForGetFieldDefinitions 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 ParametersForGetFieldDefinitions 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.
    
    Returns:
    
    ParametersForGetFieldDefinitions 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.
    
    Returns:
    
    String The return value
  - setSelect
```
public ParametersForGetFieldDefinitions 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:
    
    ParametersForGetFieldDefinitions The return value
  - getSelect
```
public String getSelect()
```
    Limits the properties returned in the result.
    
    Returns:
    
    String The return value
  - setOrderby
```
public ParametersForGetFieldDefinitions 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:
    
    ParametersForGetFieldDefinitions 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 ParametersForGetFieldDefinitions 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:
    
    ParametersForGetFieldDefinitions The return value
  - getTop
```
public Integer getTop()
```
    Limits the number of items returned from a collection.
    
    Returns:
    
    Integer The return value
  - setSkip
```
public ParametersForGetFieldDefinitions 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:
    
    ParametersForGetFieldDefinitions 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 ParametersForGetFieldDefinitions 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:
    
    ParametersForGetFieldDefinitions 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 ParametersForGetFieldDefinitions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParametersForGetFieldDefinitions

Method Detail

setRepoId

getRepoId

setPrefer

getPrefer

setCulture

getCulture

setSelect

getSelect

setOrderby

getOrderby

setTop

getTop

setSkip

getSkip

setCount

isCount