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
LinkDefinition	getLinkDefinition(ParametersForGetLinkDefinition parameters) - Returns a single link definition associated with the specified ID. - Provide a link definition ID and get the associated link definition.
LinkDefinitionCollectionResponse	listLinkDefinitions(ParametersForListLinkDefinitions 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	listLinkDefinitionsForEach(Function<LinkDefinitionCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListLinkDefinitions parameters) Provides the functionality to iteratively (i.e.
LinkDefinitionCollectionResponse	listLinkDefinitionsNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.

Method Detail

listLinkDefinitions

LinkDefinitionCollectionResponse listLinkDefinitions(ParametersForListLinkDefinitions 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.
- Required OAuth scope: repository.Read

Parameters:

parameters - An object of type ParametersForListLinkDefinitions which encapsulates the parameters of listLinkDefinitions method.

Returns:

LinkDefinitionCollectionResponse The return value

listLinkDefinitionsNextLink

LinkDefinitionCollectionResponse listLinkDefinitionsNextLink(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:

LinkDefinitionCollectionResponse The return value

listLinkDefinitionsForEach

void listLinkDefinitionsForEach(Function<LinkDefinitionCollectionResponse,Boolean> callback,
                                Integer maxPageSize,
                                ParametersForListLinkDefinitions parameters)

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

getLinkDefinition

LinkDefinition getLinkDefinition(ParametersForGetLinkDefinition parameters)

- Returns a single link definition associated with the specified ID.
- Provide a link definition 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
- Required OAuth scope: repository.Read

Parameters:

parameters - An object of type ParametersForGetLinkDefinition which encapsulates the parameters of getLinkDefinition method.

Returns:

LinkDefinition The return value