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
AuditReasons	getAuditReasons(ParametersForGetAuditReasons parameters) - Returns the audit reasons associated with the authenticated user.

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

getAuditReasons

public AuditReasons getAuditReasons(ParametersForGetAuditReasons 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.

Specified by:

getAuditReasons in interface AuditReasonsClient

Parameters:

parameters - An object of type ParametersForGetAuditReasons which encapsulates the parameters of getAuditReasons method.

Returns:

AuditReasons The return value