com.laserfiche.repository.api.clients

Interface SimpleSearchesClient

All Known Implementing Classes:

SimpleSearchesClientImpl

public interface SimpleSearchesClient

The Laserfiche Repository SimpleSearches API client.

Method Summary

Modifier and Type	Method and Description
ODataValueContextOfIListOfEntry	createSimpleSearchOperation(ParametersForCreateSimpleSearchOperation 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.

Method Detail

createSimpleSearchOperation

ODataValueContextOfIListOfEntry createSimpleSearchOperation(ParametersForCreateSimpleSearchOperation 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. 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.

Parameters:

parameters - An object of type ParametersForCreateSimpleSearchOperation which encapsulates the parameters of createSimpleSearchOperation method.

Returns:

ODataValueContextOfIListOfEntry The return value