com.laserfiche.repository.api.clients.impl

Class SearchesClientImpl

java.lang.Object

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

com.laserfiche.repository.api.clients.impl.SearchesClientImpl

All Implemented Interfaces:

SearchesClient

public class SearchesClientImpl
extends ApiClient
implements SearchesClient

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

Method Summary

Modifier and Type	Method and Description
ODataValueOfBoolean	cancelOrCloseSearch(ParametersForCancelOrCloseSearch parameters) - Cancels a currently running search. - Closes a completed search.
AcceptedOperation	createSearchOperation(ParametersForCreateSearchOperation parameters) - Runs a search operation on the repository. - Optional body parameters: FuzzyType: (default none), which can be used to determine what is considered a match by number of letters or percentage.
ODataValueContextOfIListOfContextHit	getSearchContextHits(ParametersForGetSearchContextHits parameters) - Returns the context hits associated with a search result entry. - Given a searchToken, and rowNumber associated with a search entry in the listing, return the context hits for that entry. - Default page size: 100.
void	getSearchContextHitsForEach(Function<ODataValueContextOfIListOfContextHit,Boolean> callback, Integer maxPageSize, ParametersForGetSearchContextHits parameters) Provides the functionality to iteratively (i.e.
ODataValueContextOfIListOfContextHit	getSearchContextHitsNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.
ODataValueContextOfIListOfEntry	getSearchResults(ParametersForGetSearchResults parameters) - Returns a search result listing if the search is completed. - Optional query parameter: groupByOrderType (default false).
void	getSearchResultsForEach(Function<ODataValueContextOfIListOfEntry,Boolean> callback, Integer maxPageSize, ParametersForGetSearchResults parameters) Provides the functionality to iteratively (i.e.
ODataValueContextOfIListOfEntry	getSearchResultsNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.
OperationProgress	getSearchStatus(ParametersForGetSearchStatus parameters) - Returns search status. - Provide a token (returned in the create search asynchronous route), and get the search status, progress, and any errors that may have occurred.

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

SearchesClientImpl

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

Method Detail

getSearchStatus

public OperationProgress getSearchStatus(ParametersForGetSearchStatus parameters)

Description copied from interface: SearchesClient

- Returns search status.
- Provide a token (returned in the create search asynchronous route), and get the search status, progress, and any errors that may have occurred. When the search is completed, the Location header can be inspected as a link to the search results.
- OperationStatus can be one of the following : NotStarted, InProgress, Completed, Failed, or Canceled.

Specified by:

getSearchStatus in interface SearchesClient

Parameters:

parameters - An object of type ParametersForGetSearchStatus which encapsulates the parameters of getSearchStatus method.

Returns:

OperationProgress The return value

cancelOrCloseSearch

public ODataValueOfBoolean cancelOrCloseSearch(ParametersForCancelOrCloseSearch parameters)

Description copied from interface: SearchesClient

- Cancels a currently running search.
- Closes a completed search.

Specified by:

cancelOrCloseSearch in interface SearchesClient

Parameters:

parameters - An object of type ParametersForCancelOrCloseSearch which encapsulates the parameters of cancelOrCloseSearch method.

Returns:

ODataValueOfBoolean The return value

getSearchContextHits

public ODataValueContextOfIListOfContextHit getSearchContextHits(ParametersForGetSearchContextHits parameters)

Description copied from interface: SearchesClient

- Returns the context hits associated with a search result entry.
- Given a searchToken, 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.

Specified by:

getSearchContextHits in interface SearchesClient

Parameters:

parameters - An object of type ParametersForGetSearchContextHits which encapsulates the parameters of getSearchContextHits method.

Returns:

ODataValueContextOfIListOfContextHit The return value

getSearchContextHitsNextLink

public ODataValueContextOfIListOfContextHit getSearchContextHitsNextLink(String nextLink,
                                                                         int maxPageSize)

Description copied from interface: SearchesClient

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

Specified by:

getSearchContextHitsNextLink in interface SearchesClient

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:

ODataValueContextOfIListOfContextHit The return value

getSearchContextHitsForEach

public void getSearchContextHitsForEach(Function<ODataValueContextOfIListOfContextHit,Boolean> callback,
                                        Integer maxPageSize,
                                        ParametersForGetSearchContextHits parameters)

Description copied from interface: SearchesClient

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

Specified by:

getSearchContextHitsForEach in interface SearchesClient

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 ParametersForGetSearchContextHits which encapsulates the parameters of getSearchContextHits method.

createSearchOperation

public AcceptedOperation createSearchOperation(ParametersForCreateSearchOperation parameters)

Description copied from interface: SearchesClient

- Runs a search operation on the repository.
- 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). The status for search operations must be checked via the Search specific status checking route.

Specified by:

createSearchOperation in interface SearchesClient

Parameters:

parameters - An object of type ParametersForCreateSearchOperation which encapsulates the parameters of createSearchOperation method.

Returns:

AcceptedOperation The return value

getSearchResults

public ODataValueContextOfIListOfEntry getSearchResults(ParametersForGetSearchResults parameters)

Description copied from interface: SearchesClient

- Returns a search result listing if the search is completed.
- 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.
- 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". Search results expire after 5 minutes, but can be refreshed by retrieving the results again.
- 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.

Specified by:

getSearchResults in interface SearchesClient

Parameters:

parameters - An object of type ParametersForGetSearchResults which encapsulates the parameters of getSearchResults method.

Returns:

ODataValueContextOfIListOfEntry The return value

getSearchResultsNextLink

public ODataValueContextOfIListOfEntry getSearchResultsNextLink(String nextLink,
                                                                int maxPageSize)

Description copied from interface: SearchesClient

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

Specified by:

getSearchResultsNextLink in interface SearchesClient

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:

ODataValueContextOfIListOfEntry The return value

getSearchResultsForEach

public void getSearchResultsForEach(Function<ODataValueContextOfIListOfEntry,Boolean> callback,
                                    Integer maxPageSize,
                                    ParametersForGetSearchResults parameters)

Description copied from interface: SearchesClient

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

Specified by:

getSearchResultsForEach in interface SearchesClient

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 ParametersForGetSearchResults which encapsulates the parameters of getSearchResults method.