com.laserfiche.repository.api.clients

Interface FieldDefinitionsClient

All Known Implementing Classes:

FieldDefinitionsClientImpl

public interface FieldDefinitionsClient

Method Summary

Modifier and Type	Method and Description
CompletableFuture<WFieldInfo>	getFieldDefinitionById(String repoId, Integer fieldDefinitionId, String culture, String select) - Returns a single field definition associated with the specified ID.
CompletableFuture<ODataValueContextOfIListOfWFieldInfo>	getFieldDefinitions(String repoId, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count) - Returns a paged listing of field definitions available in the specified repository.
CompletableFuture<Void>	getFieldDefinitionsForEach(Function<CompletableFuture<ODataValueContextOfIListOfWFieldInfo>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count) Provides the functionality to iteratively (i.e.
CompletableFuture<ODataValueContextOfIListOfWFieldInfo>	getFieldDefinitionsNextLink(String nextLink, Integer maxPageSize) Returns the next subset of the requested collection, using a nextlink url.

Method Detail

getFieldDefinitionById

CompletableFuture<WFieldInfo> getFieldDefinitionById(String repoId,
                                                     Integer fieldDefinitionId,
                                                     String culture,
                                                     String select)

- 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

Parameters:

repoId - The requested repository ID.

fieldDefinitionId - The requested field definition ID.

culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.

select - Limits the properties returned in the result.

Returns:

CompletableFuture<WFieldInfo> The return value

getFieldDefinitions

CompletableFuture<ODataValueContextOfIListOfWFieldInfo> getFieldDefinitions(String repoId,
                                                                            String prefer,
                                                                            String culture,
                                                                            String select,
                                                                            String orderby,
                                                                            Integer top,
                                                                            Integer skip,
                                                                            Boolean count)

- 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.

Parameters:

repoId - The requested repository ID.

prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.

select - Limits the properties returned in the result.

orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.

top - Limits the number of items returned from a collection.

skip - Excludes the specified number of items of the queried collection from the result.

count - Indicates whether the total count of items within a collection are returned in the result.

Returns:

CompletableFuture<ODataValueContextOfIListOfWFieldInfo> The return value

getFieldDefinitionsNextLink

CompletableFuture<ODataValueContextOfIListOfWFieldInfo> getFieldDefinitionsNextLink(String nextLink,
                                                                                    Integer 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:

CompletableFuture<ODataValueContextOfIListOfWFieldInfo> The return value

getFieldDefinitionsForEach

CompletableFuture<Void> getFieldDefinitionsForEach(Function<CompletableFuture<ODataValueContextOfIListOfWFieldInfo>,CompletableFuture<Boolean>> callback,
                                                   Integer maxPageSize,
                                                   String repoId,
                                                   String prefer,
                                                   String culture,
                                                   String select,
                                                   String orderby,
                                                   Integer top,
                                                   Integer skip,
                                                   Boolean count)

Provides the functionality to iteratively (i.e. through paging) call <b>getFieldDefinitions</b>, 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.

repoId - The requested repository ID.

prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.

select - Limits the properties returned in the result.

orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.

top - Limits the number of items returned from a collection.

skip - Excludes the specified number of items of the queried collection from the result.

count - Indicates whether the total count of items within a collection are returned in the result.

Returns:

CompletableFuture<Void> The return value