Package org.bonitasoft.engine.search

Class SearchCommands

java.lang.Object

org.bonitasoft.engine.search.AbstractSearchEntity<org.bonitasoft.engine.command.CommandDescriptor,SCommand>

org.bonitasoft.engine.search.AbstractCommandSearchEntity

org.bonitasoft.engine.search.SearchCommands

All Implemented Interfaces:

TransactionContent, TransactionContentWithResult<org.bonitasoft.engine.search.SearchResult<org.bonitasoft.engine.command.CommandDescriptor>>

public class SearchCommands
extends AbstractCommandSearchEntity

Author:

Yanyan Liu

Constructor Summary

Constructors

Constructor	Description
SearchCommands(CommandService commandService, SearchCommandDescriptor searchDescriptor, org.bonitasoft.engine.search.SearchOptions options)

Method Summary

Modifier and Type	Method	Description
long	executeCount(QueryOptions searchOptions)	Execute the count here
List<SCommand>	executeSearch(QueryOptions searchOptions)	Execute the search here

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

convertToClientObjects

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

SearchCommands

public SearchCommands(CommandService commandService,
 SearchCommandDescriptor searchDescriptor,
 org.bonitasoft.engine.search.SearchOptions options)

Method Details

executeCount

public long executeCount(QueryOptions searchOptions)
                  throws SBonitaReadException

Description copied from class: AbstractSearchEntity

Execute the count here

Specified by:

executeCount in class AbstractSearchEntity<org.bonitasoft.engine.command.CommandDescriptor,SCommand>

Parameters:

searchOptions - 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<SCommand> executeSearch(QueryOptions searchOptions)
                             throws SBonitaReadException

Description copied from class: AbstractSearchEntity

Execute the search here

Specified by:

executeSearch in class AbstractSearchEntity<org.bonitasoft.engine.command.CommandDescriptor,SCommand>

Parameters:

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