com.laserfiche.repository.api.clients

Interface TagDefinitionsClient

All Known Implementing Classes:

TagDefinitionsClientImpl

public interface TagDefinitionsClient

Method Summary

Modifier and Type	Method and Description
CompletableFuture<WTagInfo>	getTagDefinitionById(String repoId, Integer tagId, String culture, String select) - Returns a single tag definition.
CompletableFuture<ODataValueContextOfIListOfWTagInfo>	getTagDefinitions(String repoId, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count) - Returns all tag definitions in the repository.
CompletableFuture<Void>	getTagDefinitionsForEach(Function<CompletableFuture<ODataValueContextOfIListOfWTagInfo>,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<ODataValueContextOfIListOfWTagInfo>	getTagDefinitionsNextLink(String nextLink, Integer maxPageSize) Returns the next subset of the requested collection, using a nextlink url.

Method Detail

getTagDefinitions

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

- Returns all tag definitions in the repository. - Provide a repository ID and get a paged listing of tag definitions available in the repository. Useful when trying to display all tag definitions available, not only tags 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.

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

getTagDefinitionsNextLink

CompletableFuture<ODataValueContextOfIListOfWTagInfo> getTagDefinitionsNextLink(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<ODataValueContextOfIListOfWTagInfo> The return value

getTagDefinitionsForEach

CompletableFuture<Void> getTagDefinitionsForEach(Function<CompletableFuture<ODataValueContextOfIListOfWTagInfo>,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>getTagDefinitions</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

getTagDefinitionById

CompletableFuture<WTagInfo> getTagDefinitionById(String repoId,
                                                 Integer tagId,
                                                 String culture,
                                                 String select)

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

Parameters:

repoId - The requested repository ID.

tagId - The requested tag 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<WTagInfo> The return value