com.laserfiche.repository.api.clients

Interface SearchesClient

All Known Implementing Classes:

SearchesClientImpl

public interface SearchesClient

The Laserfiche Repository Searches API client.

Method Summary

Modifier and Type	Method and Description
SearchContextHitCollectionResponse	listSearchContextHits(ParametersForListSearchContextHits parameters) - Returns the context hits associated with a search result entry. - Given a taskId, and rowNumber associated with a search entry in the listing, return the context hits for that entry. - Default page size: 100.
void	listSearchContextHitsForEach(Function<SearchContextHitCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListSearchContextHits parameters) Provides the functionality to iteratively (i.e.
SearchContextHitCollectionResponse	listSearchContextHitsNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.
EntryCollectionResponse	listSearchResults(ParametersForListSearchResults parameters) - Returns a search result listing if the search is completed. - Search results expire after 5 minutes, but can be refreshed by retrieving the results again. - Optional query parameter: groupByOrderType (default false).
void	listSearchResultsForEach(Function<EntryCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListSearchResults parameters) Provides the functionality to iteratively (i.e.
EntryCollectionResponse	listSearchResultsNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.
StartTaskResponse	startSearchEntry(ParametersForStartSearchEntry parameters) - Runs a search operation on the repository. - The status for search operations must be checked via the Tasks route. - Optional body parameters: FuzzyType: (default none), which can be used to determine what is considered a match by number of letters or percentage.

Method Detail

startSearchEntry

StartTaskResponse startSearchEntry(ParametersForStartSearchEntry parameters)

- Runs a search operation on the repository.
- The status for search operations must be checked via the Tasks route.
- Optional body parameters: FuzzyType: (default none), which can be used to determine what is considered a match by number of letters or percentage. FuzzyFactor: integer value that determines the degree to which a search will be considered a match (integer value for NumberOfLetters, or int value representing a percentage).
- Required OAuth scope: repository.Read

Parameters:

parameters - An object of type ParametersForStartSearchEntry which encapsulates the parameters of startSearchEntry method.

Returns:

StartTaskResponse The return value

listSearchContextHits

SearchContextHitCollectionResponse listSearchContextHits(ParametersForListSearchContextHits parameters)

- Returns the context hits associated with a search result entry.
- Given a taskId, and rowNumber associated with a search entry in the listing, return the context hits for that entry.
- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.
- Required OAuth scope: repository.Read

Parameters:

parameters - An object of type ParametersForListSearchContextHits which encapsulates the parameters of listSearchContextHits method.

Returns:

SearchContextHitCollectionResponse The return value

listSearchContextHitsNextLink

SearchContextHitCollectionResponse listSearchContextHitsNextLink(String nextLink,
                                                                 int maxPageSize)

Returns the next subset of the requested collection, using a nextlink url.

Parameters:

nextLink - A url that allows retrieving the next subset of the requested collection.

maxPageSize - Optionally specify the maximum number of items to retrieve.

Returns:

SearchContextHitCollectionResponse The return value

listSearchContextHitsForEach

void listSearchContextHitsForEach(Function<SearchContextHitCollectionResponse,Boolean> callback,
                                  Integer maxPageSize,
                                  ParametersForListSearchContextHits parameters)

Provides the functionality to iteratively (i.e. through paging) call listSearchContextHits, and apply a function on the response of each iteration.

Parameters:

callback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.

maxPageSize - Optionally specify the maximum number of items to retrieve.

parameters - An object of type ParametersForListSearchContextHits which encapsulates the parameters of listSearchContextHits method.

listSearchResults

EntryCollectionResponse listSearchResults(ParametersForListSearchResults parameters)

- Returns a search result listing if the search is completed.
- Search results expire after 5 minutes, but can be refreshed by retrieving the results again.
- Optional query parameter: groupByOrderType (default false). This query parameter decides whether or not results are returned in groups based on their entry type.
- Optional query parameter: refresh (default false). If the search listing should be refreshed to show updated values.
- 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.
- Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". sort order can be either "asc" or "desc".
- Required OAuth scope: repository.Read

Parameters:

parameters - An object of type ParametersForListSearchResults which encapsulates the parameters of listSearchResults method.

Returns:

EntryCollectionResponse The return value

listSearchResultsNextLink

EntryCollectionResponse listSearchResultsNextLink(String nextLink,
                                                  int maxPageSize)

Returns the next subset of the requested collection, using a nextlink url.

Parameters:

nextLink - A url that allows retrieving the next subset of the requested collection.

maxPageSize - Optionally specify the maximum number of items to retrieve.

Returns:

EntryCollectionResponse The return value

listSearchResultsForEach

void listSearchResultsForEach(Function<EntryCollectionResponse,Boolean> callback,
                              Integer maxPageSize,
                              ParametersForListSearchResults parameters)

Provides the functionality to iteratively (i.e. through paging) call listSearchResults, and apply a function on the response of each iteration.

Parameters:

callback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.

maxPageSize - Optionally specify the maximum number of items to retrieve.

parameters - An object of type ParametersForListSearchResults which encapsulates the parameters of listSearchResults method.