com.laserfiche.repository.api.clients.impl

Class FieldDefinitionsClientImpl

java.lang.Object

com.laserfiche.repository.api.clients.impl.ApiClient

com.laserfiche.repository.api.clients.impl.FieldDefinitionsClientImpl

All Implemented Interfaces:

FieldDefinitionsClient

public class FieldDefinitionsClientImpl
extends ApiClient
implements FieldDefinitionsClient

The Laserfiche Repository FieldDefinitions API client.

Field Summary

Fields inherited from class com.laserfiche.repository.api.clients.impl.ApiClient

baseUrl, httpClient, httpRequestHandler, objectMapper

Constructor Summary

Constructors

Constructor and Description
FieldDefinitionsClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient, com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)

Method Summary

Modifier and Type	Method and Description
WFieldInfo	getFieldDefinitionById(ParametersForGetFieldDefinitionById parameters) - Returns a single field definition associated with the specified ID.
ODataValueContextOfIListOfWFieldInfo	getFieldDefinitions(ParametersForGetFieldDefinitions parameters) - Returns a paged listing of field definitions available in the specified repository. - Useful when trying to find a list of all field definitions available, rather than only those assigned to a specific entry/template. - Default page size: 100.
void	getFieldDefinitionsForEach(Function<ODataValueContextOfIListOfWFieldInfo,Boolean> callback, Integer maxPageSize, ParametersForGetFieldDefinitions parameters) Provides the functionality to iteratively (i.e.
ODataValueContextOfIListOfWFieldInfo	getFieldDefinitionsNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.

Methods inherited from class com.laserfiche.repository.api.clients.impl.ApiClient

toJson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldDefinitionsClientImpl

public FieldDefinitionsClientImpl(String baseUrl,
                                  kong.unirest.UnirestInstance httpClient,
                                  com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)

Method Detail

getFieldDefinitionById

public WFieldInfo getFieldDefinitionById(ParametersForGetFieldDefinitionById parameters)

Description copied from interface: FieldDefinitionsClient

- Returns a single field definition associated with the specified ID.
- Useful when a route provides a minimal amount of details and more information about the specific field definition is needed.
- Allowed OData query options: Select

Specified by:

getFieldDefinitionById in interface FieldDefinitionsClient

Parameters:

parameters - An object of type ParametersForGetFieldDefinitionById which encapsulates the parameters of getFieldDefinitionById method.

Returns:

WFieldInfo The return value

getFieldDefinitions

public ODataValueContextOfIListOfWFieldInfo getFieldDefinitions(ParametersForGetFieldDefinitions parameters)

Description copied from interface: FieldDefinitionsClient

- Returns a paged listing of field definitions available in the specified repository.
- Useful when trying to find a list of all field definitions available, rather than only those assigned to a specific entry/template.
- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.

Specified by:

getFieldDefinitions in interface FieldDefinitionsClient

Parameters:

parameters - An object of type ParametersForGetFieldDefinitions which encapsulates the parameters of getFieldDefinitions method.

Returns:

ODataValueContextOfIListOfWFieldInfo The return value

getFieldDefinitionsNextLink

public ODataValueContextOfIListOfWFieldInfo getFieldDefinitionsNextLink(String nextLink,
                                                                        int maxPageSize)

Description copied from interface: FieldDefinitionsClient

Returns the next subset of the requested collection, using a nextlink url.

Specified by:

getFieldDefinitionsNextLink in interface FieldDefinitionsClient

Parameters:

nextLink - A url that allows retrieving the next subset of the requested collection.

maxPageSize - Optionally specify the maximum number of items to retrieve.

Returns:

ODataValueContextOfIListOfWFieldInfo The return value

getFieldDefinitionsForEach

public void getFieldDefinitionsForEach(Function<ODataValueContextOfIListOfWFieldInfo,Boolean> callback,
                                       Integer maxPageSize,
                                       ParametersForGetFieldDefinitions parameters)

Description copied from interface: FieldDefinitionsClient

Provides the functionality to iteratively (i.e. through paging) call getFieldDefinitions, and apply a function on the response of each iteration.

Specified by:

getFieldDefinitionsForEach in interface FieldDefinitionsClient

Parameters:

callback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.

maxPageSize - Optionally specify the maximum number of items to retrieve.

parameters - An object of type ParametersForGetFieldDefinitions which encapsulates the parameters of getFieldDefinitions method.