com.laserfiche.repository.api.clients

Interface AttributesClient

All Known Implementing Classes:

AttributesClientImpl

public interface AttributesClient

The Laserfiche Repository Attributes API client.

Method Summary

Modifier and Type	Method and Description
ODataValueContextOfListOfAttribute	getTrusteeAttributeKeyValuePairs(ParametersForGetTrusteeAttributeKeyValuePairs parameters) - Returns the attribute key value pairs associated with the authenticated user.
void	getTrusteeAttributeKeyValuePairsForEach(Function<ODataValueContextOfListOfAttribute,Boolean> callback, Integer maxPageSize, ParametersForGetTrusteeAttributeKeyValuePairs parameters) Provides the functionality to iteratively (i.e.
ODataValueContextOfListOfAttribute	getTrusteeAttributeKeyValuePairsNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.
Attribute	getTrusteeAttributeValueByKey(ParametersForGetTrusteeAttributeValueByKey parameters) - Returns the attribute associated with the key.

Method Detail

getTrusteeAttributeValueByKey

Attribute getTrusteeAttributeValueByKey(ParametersForGetTrusteeAttributeValueByKey parameters)

- Returns the attribute associated with the key. Alternatively, return the attribute associated with the key within "Everyone" group.
- Optional query parameters: everyone (bool, default false). When true, the server only searches for the attribute value with the given key upon the authenticated users attributes. If false, only the authenticated users attributes will be queried.

Parameters:

parameters - An object of type ParametersForGetTrusteeAttributeValueByKey which encapsulates the parameters of getTrusteeAttributeValueByKey method.

Returns:

Attribute The return value

getTrusteeAttributeKeyValuePairs

ODataValueContextOfListOfAttribute getTrusteeAttributeKeyValuePairs(ParametersForGetTrusteeAttributeKeyValuePairs parameters)

- Returns the attribute key value pairs associated with the authenticated user. Alternatively, return only the attribute key value pairs that are associated with the "Everyone" group.
- Attribute keys can be used with subsequent calls to get specific attribute values.
- Default page size: 100. Allowed OData query options: Select, Count, OrderBy, Skip, Top, SkipToken, Prefer. Optional query parameters: everyone (bool, default false). When true, this route does not return the attributes that are tied to the currently authenticated user, but rather the attributes assigned to the "Everyone" group. Note when this is true, the response does not include both the "Everyone" groups attribute and the currently authenticated user, but only the "Everyone" groups.

Parameters:

parameters - An object of type ParametersForGetTrusteeAttributeKeyValuePairs which encapsulates the parameters of getTrusteeAttributeKeyValuePairs method.

Returns:

ODataValueContextOfListOfAttribute The return value

getTrusteeAttributeKeyValuePairsNextLink

ODataValueContextOfListOfAttribute getTrusteeAttributeKeyValuePairsNextLink(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:

ODataValueContextOfListOfAttribute The return value

getTrusteeAttributeKeyValuePairsForEach

void getTrusteeAttributeKeyValuePairsForEach(Function<ODataValueContextOfListOfAttribute,Boolean> callback,
                                             Integer maxPageSize,
                                             ParametersForGetTrusteeAttributeKeyValuePairs parameters)

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