com.laserfiche.repository.api.clients.impl

Class LinkDefinitionsClientImpl

java.lang.Object

com.laserfiche.repository.api.clients.impl.ApiClient

com.laserfiche.repository.api.clients.impl.LinkDefinitionsClientImpl

All Implemented Interfaces:

LinkDefinitionsClient

public class LinkDefinitionsClientImpl
extends ApiClient
implements LinkDefinitionsClient

Field Summary

Fields inherited from class com.laserfiche.repository.api.clients.impl.ApiClient

baseUrl, httpClient, objectMapper

Constructor Summary

Constructors

Constructor and Description
LinkDefinitionsClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient)

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.

Methods inherited from class com.laserfiche.repository.api.clients.impl.ApiClient

decideErrorMessage, deserializeToProblemDetails, getHeadersMap, getNonNullParameters, mergeMaxSizeIntoPrefer, toJson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LinkDefinitionsClientImpl

public LinkDefinitionsClientImpl(String baseUrl,
                                 kong.unirest.UnirestInstance httpClient)

Method Detail

getLinkDefinitionById

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

Description copied from interface: LinkDefinitionsClient

- 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

Specified by:

getLinkDefinitionById in interface LinkDefinitionsClient

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

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

Description copied from interface: LinkDefinitionsClient

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

Specified by:

getLinkDefinitions in interface LinkDefinitionsClient

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

public CompletableFuture<ODataValueContextOfIListOfEntryLinkTypeInfo> getLinkDefinitionsNextLink(String nextLink,
                                                                                                 Integer maxPageSize)

Description copied from interface: LinkDefinitionsClient

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

Specified by:

getLinkDefinitionsNextLink in interface LinkDefinitionsClient

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

public 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)

Description copied from interface: LinkDefinitionsClient

Provides the functionality to iteratively (i.e. through paging) call <b>getLinkDefinitions</b>, and apply a function on the response of each iteration.

Specified by:

getLinkDefinitionsForEach in interface LinkDefinitionsClient

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