com.laserfiche.repository.api.clients.SimpleSearchesClient 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.ODataValueContextOfIListOfEntry;
import com.laserfiche.repository.api.clients.params.ParametersForCreateSimpleSearchOperation;

/**
 * The Laserfiche Repository SimpleSearches API client.
 */
public interface SimpleSearchesClient {

    /**
     * - Runs a "simple" search operation on the repository.
     * - Returns a truncated search result listing.
     * - Search result listing may be truncated, depending on number of results. Additionally, searches may time out if they take too long. Use the other search route to run full searches.
     * - Optionally returns field values for the entries in the search result listing. Each field name needs to be specified in the request. Maximum limit of 10 field names.
     * - If field values are requested, only the first value is returned if it is a multi value field.
     * - Null or Empty field values should not be used to determine if a field is assigned to the entry.
     *
     * @param parameters An object of type {@link ParametersForCreateSimpleSearchOperation} which encapsulates the parameters of {@link #createSimpleSearchOperation createSimpleSearchOperation} method.
     * @return {@link ODataValueContextOfIListOfEntry} The return value
     */
    ODataValueContextOfIListOfEntry createSimpleSearchOperation(ParametersForCreateSimpleSearchOperation parameters);
}