com.laserfiche.repository.api.clients

Interface SimpleSearchesClient

All Known Implementing Classes:

SimpleSearchesClientImpl

public interface SimpleSearchesClient

Method Summary

Modifier and Type	Method and Description
CompletableFuture<ODataValueContextOfIListOfEntry>	createSimpleSearchOperation(String select, String orderby, Boolean count, String repoId, String[] fields, Boolean formatFields, SimpleSearchRequest requestBody, String culture) - Runs a "simple" search operation on the repository.

Method Detail

createSimpleSearchOperation

CompletableFuture<ODataValueContextOfIListOfEntry> createSimpleSearchOperation(String select,
                                                                               String orderby,
                                                                               Boolean count,
                                                                               String repoId,
                                                                               String[] fields,
                                                                               Boolean formatFields,
                                                                               SimpleSearchRequest requestBody,
                                                                               String culture)

- 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:

select - Limits the properties returned in the result.

orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.

count - Indicates whether the total count of items within a collection are returned in the result.

repoId - The requested repository ID.

fields - Optional array of field names. Field values corresponding to the given field names will be returned for each search result.

formatFields - Boolean for if field values should be formatted. Only applicable if Fields are specified.

requestBody - The Laserfiche search command to run.

culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting.

Returns:

CompletableFuture<ODataValueContextOfIListOfEntry> The return value