com.laserfiche.repository.api.clients

Interface FieldDefinitionsClient

All Known Implementing Classes:

FieldDefinitionsClientImpl

public interface FieldDefinitionsClient

The Laserfiche Repository FieldDefinitions API client.

Method Summary

Modifier and Type	Method and Description
FieldDefinition	getFieldDefinition(ParametersForGetFieldDefinition parameters) - Returns a single field definition associated with the specified ID.
FieldDefinitionCollectionResponse	listFieldDefinitions(ParametersForListFieldDefinitions 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	listFieldDefinitionsForEach(Function<FieldDefinitionCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListFieldDefinitions parameters) Provides the functionality to iteratively (i.e.
FieldDefinitionCollectionResponse	listFieldDefinitionsNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.

Method Detail

listFieldDefinitions

FieldDefinitionCollectionResponse listFieldDefinitions(ParametersForListFieldDefinitions 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. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.
- Required OAuth scope: repository.Read

Parameters:

parameters - An object of type ParametersForListFieldDefinitions which encapsulates the parameters of listFieldDefinitions method.

Returns:

FieldDefinitionCollectionResponse The return value

listFieldDefinitionsNextLink

FieldDefinitionCollectionResponse listFieldDefinitionsNextLink(String nextLink,
                                                               int maxPageSize)

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

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:

FieldDefinitionCollectionResponse The return value

listFieldDefinitionsForEach

void listFieldDefinitionsForEach(Function<FieldDefinitionCollectionResponse,Boolean> callback,
                                 Integer maxPageSize,
                                 ParametersForListFieldDefinitions parameters)

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

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 ParametersForListFieldDefinitions which encapsulates the parameters of listFieldDefinitions method.

getFieldDefinition

FieldDefinition getFieldDefinition(ParametersForGetFieldDefinition parameters)

- 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
- Required OAuth scope: repository.Read

Parameters:

parameters - An object of type ParametersForGetFieldDefinition which encapsulates the parameters of getFieldDefinition method.

Returns:

FieldDefinition The return value