com.laserfiche.repository.api.clients.impl

Class AuditReasonsClientImpl

java.lang.Object

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

com.laserfiche.repository.api.clients.impl.AuditReasonsClientImpl

All Implemented Interfaces:

AuditReasonsClient

public class AuditReasonsClientImpl
extends ApiClient
implements AuditReasonsClient

The Laserfiche Repository AuditReasons API client.

Field Summary

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

baseUrl, httpClient, httpRequestHandler, objectMapper

Constructor Summary

Constructors

Constructor and Description
AuditReasonsClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient, com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)

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.

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

toJson

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditReasonsClientImpl

public AuditReasonsClientImpl(String baseUrl,
                              kong.unirest.UnirestInstance httpClient,
                              com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)

Method Detail

listAuditReasons

public AuditReasonCollectionResponse listAuditReasons(ParametersForListAuditReasons parameters)

Description copied from interface: AuditReasonsClient

- 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

Specified by:

listAuditReasons in interface AuditReasonsClient

Parameters:

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

Returns:

AuditReasonCollectionResponse The return value

listAuditReasonsNextLink

public AuditReasonCollectionResponse listAuditReasonsNextLink(String nextLink,
                                                              int maxPageSize)

Description copied from interface: AuditReasonsClient

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

Specified by:

listAuditReasonsNextLink in interface AuditReasonsClient

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

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

Description copied from interface: AuditReasonsClient

Provides the functionality to iteratively (i.e. through paging) call listAuditReasons, and apply a function on the response of each iteration.

Specified by:

listAuditReasonsForEach in interface AuditReasonsClient

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.