com.laserfiche.repository.api.clients

Interface AuditReasonsClient

All Known Implementing Classes:

AuditReasonsClientImpl

public interface AuditReasonsClient

The Laserfiche Repository AuditReasons API client.

Method Summary

Modifier and Type	Method and Description
AuditReasonCollectionResponse	listAuditReasons(ParametersForListAuditReasons parameters) - Returns the audit reasons associated with the authenticated user.
void	listAuditReasonsForEach(Function<AuditReasonCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListAuditReasons parameters) Provides the functionality to iteratively (i.e.
AuditReasonCollectionResponse	listAuditReasonsNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.

Method Detail

listAuditReasons

AuditReasonCollectionResponse listAuditReasons(ParametersForListAuditReasons parameters)

- Returns the audit reasons associated with the authenticated user. Inherited audit reasons are included.
- Only includes audit reasons associated with available API functionalities, like delete entry and export document.
- If the authenticated user does not have the appropriate Laserfiche feature right, the audit reasons associated with that feature right will not be included.
- Required OAuth scope: repository.Read

Parameters:

parameters - An object of type ParametersForListAuditReasons which encapsulates the parameters of listAuditReasons method.

Returns:

AuditReasonCollectionResponse The return value

listAuditReasonsNextLink

AuditReasonCollectionResponse listAuditReasonsNextLink(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:

AuditReasonCollectionResponse The return value

listAuditReasonsForEach

void listAuditReasonsForEach(Function<AuditReasonCollectionResponse,Boolean> callback,
                             Integer maxPageSize,
                             ParametersForListAuditReasons parameters)

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