com.laserfiche.repository.api.clients.impl

Class SimpleSearchesClientImpl

java.lang.Object

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

com.laserfiche.repository.api.clients.impl.SimpleSearchesClientImpl

All Implemented Interfaces:

SimpleSearchesClient

public class SimpleSearchesClientImpl
extends ApiClient
implements SimpleSearchesClient

The Laserfiche Repository SimpleSearches 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
SimpleSearchesClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient, com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)

Method Summary

Modifier and Type	Method and Description
EntryCollectionResponse	searchEntry(ParametersForSearchEntry parameters) - 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.

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

SimpleSearchesClientImpl

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

Method Detail

searchEntry

public EntryCollectionResponse searchEntry(ParametersForSearchEntry parameters)

Description copied from 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 folder. 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. The remaining field values can be retrieved via the GET fields route. Null or Empty field values should not be used to determine if a field is assigned to the entry.
- Required OAuth scope: repository.Read

Specified by:

searchEntry in interface SimpleSearchesClient

Parameters:

parameters - An object of type ParametersForSearchEntry which encapsulates the parameters of searchEntry method.

Returns:

EntryCollectionResponse The return value