com.laserfiche.repository.api.clients.AuditReasonsClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lf-repository-api-client Show documentation

Java implementation of various foundational APIs for Laserfiche, including Repository APIs such as Entry API flows for secure and easy access to Laserfiche Repository Entries.

The newest version!

package com.laserfiche.repository.api.clients;

import com.laserfiche.repository.api.clients.impl.model.AuditReasons;
import com.laserfiche.repository.api.clients.params.ParametersForGetAuditReasons;

/**
 * The Laserfiche Repository AuditReasons API client.
 */
public 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.
     *
     * @param parameters An object of type {@link ParametersForGetAuditReasons} which encapsulates the parameters of {@link #getAuditReasons getAuditReasons} method.
     * @return {@link AuditReasons} The return value
     */
    AuditReasons getAuditReasons(ParametersForGetAuditReasons parameters);
}