com.laserfiche.repository.api.clients

Interface LinkDefinitionsClient

All Known Implementing Classes:

LinkDefinitionsClientImpl

public interface LinkDefinitionsClient

Method Summary

Modifier and Type	Method and Description
CompletableFuture<EntryLinkTypeInfo>	getLinkDefinitionById(String repoId, Integer linkTypeId, String select) - Returns a single link definition associated with the specified ID.
CompletableFuture<ODataValueContextOfIListOfEntryLinkTypeInfo>	getLinkDefinitions(String repoId, String prefer, String select, String orderby, Integer top, Integer skip, Boolean count) - Returns the link definitions in the repository.
CompletableFuture<Void>	getLinkDefinitionsForEach(Function<CompletableFuture<ODataValueContextOfIListOfEntryLinkTypeInfo>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, String prefer, String select, String orderby, Integer top, Integer skip, Boolean count) Provides the functionality to iteratively (i.e.
CompletableFuture<ODataValueContextOfIListOfEntryLinkTypeInfo>	getLinkDefinitionsNextLink(String nextLink, Integer maxPageSize) Returns the next subset of the requested collection, using a nextlink url.

Method Detail

getLinkDefinitionById

CompletableFuture<EntryLinkTypeInfo> getLinkDefinitionById(String repoId,
                                                           Integer linkTypeId,
                                                           String select)

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

repoId - The requested repository ID.

linkTypeId - The requested link type ID.

select - Limits the properties returned in the result.

Returns:

CompletableFuture<EntryLinkTypeInfo> The return value

getLinkDefinitions

CompletableFuture<ODataValueContextOfIListOfEntryLinkTypeInfo> getLinkDefinitions(String repoId,
                                                                                  String prefer,
                                                                                  String select,
                                                                                  String orderby,
                                                                                  Integer top,
                                                                                  Integer skip,
                                                                                  Boolean count)

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

repoId - The requested repository ID.

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

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<ODataValueContextOfIListOfEntryLinkTypeInfo> The return value

getLinkDefinitionsNextLink

CompletableFuture<ODataValueContextOfIListOfEntryLinkTypeInfo> getLinkDefinitionsNextLink(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<ODataValueContextOfIListOfEntryLinkTypeInfo> The return value

getLinkDefinitionsForEach

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

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

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