com.laserfiche.repository.api.clients.params

Class ParametersForGetLinkDefinitions

java.lang.Object

com.laserfiche.repository.api.clients.params.ParametersForGetLinkDefinitions

public class ParametersForGetLinkDefinitions
extends Object

The encapsulated parameters for getLinkDefinitions.

Constructor Summary

Constructors

Constructor and Description
ParametersForGetLinkDefinitions()

Method Summary

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.
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.
ParametersForGetLinkDefinitions	setCount(Boolean count) Sets the value of the count parameter and returns the current object, to enable chaining further setters.
ParametersForGetLinkDefinitions	setOrderby(String orderby) Sets the value of the orderby parameter and returns the current object, to enable chaining further setters.
ParametersForGetLinkDefinitions	setPrefer(String prefer) Sets the value of the prefer parameter and returns the current object, to enable chaining further setters.
ParametersForGetLinkDefinitions	setRepoId(String repoId) Sets the value of the repoId parameter and returns the current object, to enable chaining further setters.
ParametersForGetLinkDefinitions	setSelect(String select) Sets the value of the select parameter and returns the current object, to enable chaining further setters.
ParametersForGetLinkDefinitions	setSkip(Integer skip) Sets the value of the skip parameter and returns the current object, to enable chaining further setters.
ParametersForGetLinkDefinitions	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

ParametersForGetLinkDefinitions

public ParametersForGetLinkDefinitions()

Method Detail

setRepoId

public ParametersForGetLinkDefinitions 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:

ParametersForGetLinkDefinitions The return value

getRepoId

public String getRepoId()

The requested repository ID.

Returns:

String The return value

setPrefer

public ParametersForGetLinkDefinitions 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:

ParametersForGetLinkDefinitions 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 ParametersForGetLinkDefinitions 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:

ParametersForGetLinkDefinitions The return value

getSelect

public String getSelect()

Limits the properties returned in the result.

Returns:

String The return value

setOrderby

public ParametersForGetLinkDefinitions 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:

ParametersForGetLinkDefinitions 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 ParametersForGetLinkDefinitions 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:

ParametersForGetLinkDefinitions The return value

getTop

public Integer getTop()

Limits the number of items returned from a collection.

Returns:

Integer The return value

setSkip

public ParametersForGetLinkDefinitions 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:

ParametersForGetLinkDefinitions 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 ParametersForGetLinkDefinitions 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:

ParametersForGetLinkDefinitions 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