com.lexmark.saperion.client.implementation

Class SearchClientImpl<ItemType>

java.lang.Object

com.lexmark.saperion.client.implementation.SearchClientImpl<ItemType>

All Implemented Interfaces:

SearchClient<ItemType>, SearchExecutionService<ItemType>

Direct Known Subclasses:

FolderDocumentSearchServiceClientImpl, GroupMembershipClientForGroupsImpl, GroupMembershipClientForUsersImpl, TenantManagementClientImpl

public class SearchClientImpl<ItemType>
extends Object
implements SearchClient<ItemType>

This is the default implementation of SearchClient.

Author:

jschwarz

Constructor Summary

Constructors

Constructor and Description
SearchClientImpl(SearchExecutionService<ItemType> searchService)

Method Summary

Modifier and Type	Method and Description
boolean	exists(Expression filter) This convenience method checks whether an element matching the filter actually exists.
Iterable<ItemType>	list() This method returns an iterable over the complete result of the search using the default paging.
Iterable<ItemType>	list(Expression filter) This method returns an iterable over the filtered result of the search using the default paging.
Iterable<ItemType>	list(Expression filter, List<FieldOrderDescriptor> order, PageDefinition paging) This method returns an iterable over the filtered result of the search paging as defined.
Iterable<ItemType>	list(Expression filter, PageDefinition paging) This method returns an iterable over the filtered result of the search paging as defined.
Iterable<ItemType>	list(List<String> fields, Expression filter, List<FieldOrderDescriptor> order, PageDefinition paging) This method returns an iterable over the filtered result of the search paging as defined.
Iterable<ItemType>	list(List<String> fields, Expression filter, PageDefinition paging) This method returns an iterable over the filtered result of the search paging as defined.
Iterable<ItemType>	list(Statement statement, PageDefinition paging) This method returns an iterable over the filtered result of the search paging as defined.
SearchResultPage<ItemType>	page(int offset, int pageSize) This method retrieves the given page of the result of the search.
SearchResultPage<ItemType>	page(PageDefinition paging) This method retrieves the given page of the result of the search.
SearchResultPage<ItemType>	search(Statement statement, PageDefinition pageDefinition) Returns the result page for a query execution with custom paging/fetch window size.
ItemType	uniqueResult(Expression filter) This convenience method expects the filter to return at most one result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchClientImpl

public SearchClientImpl(SearchExecutionService<ItemType> searchService)

Method Detail

search

public SearchResultPage<ItemType> search(Statement statement,
                                         PageDefinition pageDefinition)
                                  throws EcmException

Description copied from interface: SearchExecutionService

Returns the result page for a query execution with custom paging/fetch window size.

Specified by:

search in interface SearchExecutionService<ItemType>

Parameters:

statement - search expression

pageDefinition - result page offset and size

Returns:

result set page

Throws:

SearchException - indicates any error during the search operation

EcmException

list

public Iterable<ItemType> list(Statement statement,
                               PageDefinition paging)
                        throws EcmException

Description copied from interface: SearchClient

This method returns an iterable over the filtered result of the search paging as defined.

Specified by:

list in interface SearchClient<ItemType>

Parameters:

statement - a statement filtering the result

paging - the paging the returned iterator should use

Returns:

an iterator over the filtered result paging as defined.

Throws:

EcmException

list

public Iterable<ItemType> list(List<String> fields,
                               Expression filter,
                               List<FieldOrderDescriptor> order,
                               PageDefinition paging)
                        throws EcmException

Description copied from interface: SearchClient

This method returns an iterable over the filtered result of the search paging as defined.

Specified by:

list in interface SearchClient<ItemType>

Parameters:

fields - the fields of the result to deliver

filter - a filter for the result

order - the order of the result list

paging - the paging the returned iterator should use

Returns:

an iterator over the filtered result paging as defined.

Throws:

EcmException

list

public Iterable<ItemType> list(List<String> fields,
                               Expression filter,
                               PageDefinition paging)
                        throws EcmException

Description copied from interface: SearchClient

This method returns an iterable over the filtered result of the search paging as defined.

Specified by:

list in interface SearchClient<ItemType>

Parameters:

fields - the fields of the result to deliver

filter - a filter for the result

paging - the paging the returned iterator should use

Returns:

an iterator over the filtered result paging as defined.

Throws:

EcmException

list

public Iterable<ItemType> list(Expression filter,
                               List<FieldOrderDescriptor> order,
                               PageDefinition paging)
                        throws EcmException

Description copied from interface: SearchClient

This method returns an iterable over the filtered result of the search paging as defined.

Specified by:

list in interface SearchClient<ItemType>

Parameters:

filter - a filter for the result

order - the order of the result list

paging - the paging the returned iterator should use

Returns:

an iterator over the filtered result paging as defined.

Throws:

EcmException

list

public Iterable<ItemType> list(Expression filter,
                               PageDefinition paging)
                        throws EcmException

Description copied from interface: SearchClient

This method returns an iterable over the filtered result of the search paging as defined.

Specified by:

list in interface SearchClient<ItemType>

Parameters:

filter - a filter for the result

paging - the paging the returned iterator should use

Returns:

an iterator over the filtered result paging as defined.

Throws:

EcmException

list

public Iterable<ItemType> list(Expression filter)
                        throws EcmException

Description copied from interface: SearchClient

This method returns an iterable over the filtered result of the search using the default paging.

Specified by:

list in interface SearchClient<ItemType>

Parameters:

filter - a filter for the result

Returns:

an iterator over the filtered result using the default paging.

Throws:

EcmException

list

public Iterable<ItemType> list()
                        throws EcmException

Description copied from interface: SearchClient

This method returns an iterable over the complete result of the search using the default paging.

Specified by:

list in interface SearchClient<ItemType>

Returns:

an iterator over the complete result using the default paging.

Throws:

EcmException

uniqueResult

public ItemType uniqueResult(Expression filter)
                      throws EcmException

Description copied from interface: SearchClient

This convenience method expects the filter to return at most one result. If no such element exists null is returned. If one such element exists it is returned. Otherwise an IllegalRequestException is thrown.

Specified by:

uniqueResult in interface SearchClient<ItemType>

Parameters:

filter - a filter yielding true for at most one element

Returns:

the element the filter yields true for

Throws:

EcmException

exists

public boolean exists(Expression filter)
               throws EcmException

Description copied from interface: SearchClient

This convenience method checks whether an element matching the filter actually exists.

Specified by:

exists in interface SearchClient<ItemType>

Parameters:

filter - the filter to check

Returns:

whether an element matching the filter actually exists

Throws:

EcmException

page

public SearchResultPage<ItemType> page(PageDefinition paging)
                                throws EcmException

Description copied from interface: SearchClient

This method retrieves the given page of the result of the search.

Specified by:

page in interface SearchClient<ItemType>

Parameters:

paging - the page to retrieve

Returns:

the given page of the result of the search

Throws:

EcmException

page

public SearchResultPage<ItemType> page(int offset,
                                       int pageSize)
                                throws EcmException

Description copied from interface: SearchClient

This method retrieves the given page of the result of the search.

Specified by:

page in interface SearchClient<ItemType>

Parameters:

offset - the offset of the page

pageSize - the size of the page

Returns:

the given page of the result of the search

Throws:

EcmException