Package org.bonitasoft.engine.api.impl.transaction.page

Class SearchPages

java.lang.Object

org.bonitasoft.engine.search.AbstractSearchEntity<org.bonitasoft.engine.page.Page,SPage>

org.bonitasoft.engine.api.impl.transaction.page.SearchPages

All Implemented Interfaces:

TransactionContent, TransactionContentWithResult<org.bonitasoft.engine.search.SearchResult<org.bonitasoft.engine.page.Page>>

public class SearchPages
extends AbstractSearchEntity<org.bonitasoft.engine.page.Page,SPage>

Author:

Baptiste Mesta

Constructor Summary

Constructors

Constructor	Description
SearchPages(PageService pageService, SearchEntityDescriptor searchDescriptor, org.bonitasoft.engine.search.SearchOptions options)

Method Summary

Modifier and Type	Method	Description
List<org.bonitasoft.engine.page.Page>	convertToClientObjects(List<SPage> pages)	Must convert server objects in client objects here
long	executeCount(QueryOptions queryOptions)	Execute the count here
List<SPage>	executeSearch(QueryOptions queryOptions)	Execute the search here

Methods inherited from class org.bonitasoft.engine.search.AbstractSearchEntity

execute, getResult, getSearchFilter, search, search, validateQuery

Methods inherited from class java.lang.Object

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

Constructor Details

SearchPages

public SearchPages(PageService pageService,
 SearchEntityDescriptor searchDescriptor,
 org.bonitasoft.engine.search.SearchOptions options)

Method Details

executeCount

public long executeCount(QueryOptions queryOptions)
                  throws SBonitaReadException

Description copied from class: AbstractSearchEntity

Execute the count here

Specified by:

executeCount in class AbstractSearchEntity<org.bonitasoft.engine.page.Page,SPage>

Parameters:

queryOptions - The query options to execute the count with

Returns:

The number of result on the server

Throws:

SBonitaReadException - when the search failed to retrieve the count number

executeSearch

public List<SPage> executeSearch(QueryOptions queryOptions)
                          throws SBonitaReadException

Description copied from class: AbstractSearchEntity

Execute the search here

Specified by:

executeSearch in class AbstractSearchEntity<org.bonitasoft.engine.page.Page,SPage>

Parameters:

queryOptions - The query options to execute the search with

Returns:

The list of searched server objects

Throws:

SBonitaReadException - when the search failed to retrieve the results

convertToClientObjects

public List<org.bonitasoft.engine.page.Page> convertToClientObjects(List<SPage> pages)

Description copied from class: AbstractSearchEntity

Must convert server objects in client objects here

Specified by:

convertToClientObjects in class AbstractSearchEntity<org.bonitasoft.engine.page.Page,SPage>

Parameters:

pages - The server object to convert

Returns:

The list of the client objects corresponding to the server objects