com.laserfiche.repository.api.clients

Interface LinkDefinitionsClient

All Known Implementing Classes:

LinkDefinitionsClientImpl

public interface LinkDefinitionsClient

The Laserfiche Repository LinkDefinitions API client.

Method Summary

Modifier and Type	Method and Description
EntryLinkTypeInfo	getLinkDefinitionById(ParametersForGetLinkDefinitionById parameters) - Returns a single link definition associated with the specified ID. - Provide a link type ID and get the associated link definition.
ODataValueContextOfIListOfEntryLinkTypeInfo	getLinkDefinitions(ParametersForGetLinkDefinitions parameters) - Returns the link definitions in the repository. - Provide a repository ID and get a paged listing of link definitions available in the repository.
void	getLinkDefinitionsForEach(Function<ODataValueContextOfIListOfEntryLinkTypeInfo,Boolean> callback, Integer maxPageSize, ParametersForGetLinkDefinitions parameters) Provides the functionality to iteratively (i.e.
ODataValueContextOfIListOfEntryLinkTypeInfo	getLinkDefinitionsNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.

Method Detail

getLinkDefinitionById

EntryLinkTypeInfo getLinkDefinitionById(ParametersForGetLinkDefinitionById parameters)

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

Parameters:

parameters - An object of type ParametersForGetLinkDefinitionById which encapsulates the parameters of getLinkDefinitionById method.

Returns:

EntryLinkTypeInfo The return value

getLinkDefinitions

ODataValueContextOfIListOfEntryLinkTypeInfo getLinkDefinitions(ParametersForGetLinkDefinitions parameters)

- Returns the link definitions in the repository.
- Provide a repository ID and get a paged listing of link definitions available in the repository. Useful when trying to display all link definitions available, not only links assigned to a specific entry.
- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.

Parameters:

parameters - An object of type ParametersForGetLinkDefinitions which encapsulates the parameters of getLinkDefinitions method.

Returns:

ODataValueContextOfIListOfEntryLinkTypeInfo The return value

getLinkDefinitionsNextLink

ODataValueContextOfIListOfEntryLinkTypeInfo getLinkDefinitionsNextLink(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:

ODataValueContextOfIListOfEntryLinkTypeInfo The return value

getLinkDefinitionsForEach

void getLinkDefinitionsForEach(Function<ODataValueContextOfIListOfEntryLinkTypeInfo,Boolean> callback,
                               Integer maxPageSize,
                               ParametersForGetLinkDefinitions parameters)

Provides the functionality to iteratively (i.e. through paging) call getLinkDefinitions, 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 ParametersForGetLinkDefinitions which encapsulates the parameters of getLinkDefinitions method.