com.laserfiche.repository.api.clients.params

Class ParametersForSearchEntry

java.lang.Object

com.laserfiche.repository.api.clients.params.ParametersForSearchEntry

public class ParametersForSearchEntry
extends Object

The encapsulated parameters for searchEntry.

Constructor Summary

Constructors

Constructor and Description
ParametersForSearchEntry()

Method Summary

Modifier and Type	Method and Description
String	getCulture() An optional query parameter used to indicate the locale that should be used for formatting.
String[]	getFields() Optional array of field names.
String	getOrderby() Specifies the order in which items are returned.
String	getRepositoryId() The requested repository ID.
SearchEntryRequest	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	isFormatFieldValues() Indicates if field values should be formatted.
ParametersForSearchEntry	setCount(Boolean count) Sets the value of the count parameter and returns the current object, to enable chaining further setters.
ParametersForSearchEntry	setCulture(String culture) Sets the value of the culture parameter and returns the current object, to enable chaining further setters.
ParametersForSearchEntry	setFields(String... fields) Sets the value of the fields parameter and returns the current object, to enable chaining further setters.
ParametersForSearchEntry	setFormatFieldValues(Boolean formatFieldValues) Sets the value of the formatFieldValues parameter and returns the current object, to enable chaining further setters.
ParametersForSearchEntry	setOrderby(String orderby) Sets the value of the orderby parameter and returns the current object, to enable chaining further setters.
ParametersForSearchEntry	setRepositoryId(String repositoryId) Sets the value of the repositoryId parameter and returns the current object, to enable chaining further setters.
ParametersForSearchEntry	setRequestBody(SearchEntryRequest requestBody)
ParametersForSearchEntry	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

ParametersForSearchEntry

public ParametersForSearchEntry()

Method Detail

setSelect

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

ParametersForSearchEntry The return value

getSelect

public String getSelect()

Limits the properties returned in the result.

Returns:

String The return value

setOrderby

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

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

ParametersForSearchEntry 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

setRepositoryId

public ParametersForSearchEntry setRepositoryId(String repositoryId)

Sets the value of the repositoryId parameter and returns the current object, to enable chaining further setters.

Parameters:

repositoryId - The requested repository ID.

Returns:

ParametersForSearchEntry The return value

getRepositoryId

public String getRepositoryId()

The requested repository ID.

Returns:

String The return value

setFields

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

ParametersForSearchEntry 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

setFormatFieldValues

public ParametersForSearchEntry setFormatFieldValues(Boolean formatFieldValues)

Sets the value of the formatFieldValues parameter and returns the current object, to enable chaining further setters.

Parameters:

formatFieldValues - Indicates if field values should be formatted. Only applicable if Fields are specified. The default value is false.

Returns:

ParametersForSearchEntry The return value

isFormatFieldValues

public Boolean isFormatFieldValues()

Indicates if field values should be formatted. Only applicable if Fields are specified. The default value is false.

Returns:

Boolean The return value

setRequestBody

public ParametersForSearchEntry setRequestBody(SearchEntryRequest requestBody)

getRequestBody

public SearchEntryRequest getRequestBody()

setCulture

public ParametersForSearchEntry 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 formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.

Returns:

ParametersForSearchEntry 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 formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.

Returns:

String The return value