org.bonitasoft.engine.search

Class AbstractSearchEntity<C extends Serializable,S extends org.bonitasoft.engine.persistence.PersistentObject>

java.lang.Object

org.bonitasoft.engine.search.AbstractSearchEntity<C,S>

Type Parameters:

C - The client object

S - The server object

All Implemented Interfaces:

org.bonitasoft.engine.commons.transaction.TransactionContent, org.bonitasoft.engine.commons.transaction.TransactionContentWithResult<SearchResult<C>>

Direct Known Subclasses:

AbstractActivityInstanceSearchEntity, AbstractArchiveActivityInstanceSearchEntity, AbstractArchivedCommentsSearchEntity, AbstractArchivedConnectorInstanceSearchEntity, AbstractArchivedDocumentSearchEntity, AbstractArchivedHumanTaskInstanceSearchEntity, AbstractArchivedProcessInstanceSearchEntity, AbstractCommandSearchEntity, AbstractCommentSearchEntity, AbstractConnectorSearchEntity, AbstractDocumentSearchEntity, AbstractGroupSearchEntity, AbstractHumanTaskInstanceSearchEntity, AbstractProcessDeploymentInfoSearchEntity, AbstractProcessInstanceSearchEntity, AbstractProfileSearchEntity, AbstractRoleSearchEntity, AbstractSupervisorSearchEntity, AbstractUserSearchEntity, ExternalIdentityMappingCommand.ExternalIdentityMappingSearchEntity, SearchApplicationMenus, SearchApplicationPages, SearchApplications, SearchArchivedActivityInstanceSupervisedBy, SearchArchivedFlowNodeInstances, SearchArchivedFlowNodeInstanceSupervisedBy, SearchCustomUserInfoValues, SearchFlowNodeInstances, SearchFlowNodeInstanceSupervisedBy, SearchFormMappings, SearchPages, SearchProfileEntries, SearchProfileMembersForProfile, SearchProfiles, SearchThemes, SearchTimerEventTriggerInstances, SearchWaitingEvents

public abstract class AbstractSearchEntity<C extends Serializable,S extends org.bonitasoft.engine.persistence.PersistentObject>
extends Object
implements org.bonitasoft.engine.commons.transaction.TransactionContentWithResult<SearchResult<C>>

Abstract class to allow to search server object and convert them to client object

Author:

Matthieu Chaffotte, Baptiste Mesta, Celine Souchet

Constructor Summary

Constructors

Constructor and Description
AbstractSearchEntity(SearchEntityDescriptor searchDescriptor, SearchOptions options)

Method Summary

Modifier and Type	Method and Description
abstract List<C>	convertToClientObjects(List<S> serverObjects) Must convert server objects in client objects here
void	execute()
abstract long	executeCount(org.bonitasoft.engine.persistence.QueryOptions queryOptions) Execute the count here
abstract List<S>	executeSearch(org.bonitasoft.engine.persistence.QueryOptions queryOptions) Execute the search here
SearchResult<C>	getResult()
protected SearchFilter	getSearchFilter(SearchOptions searchOptions, String searchedKey)
protected void	validateQuery(SearchOptions options)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSearchEntity

public AbstractSearchEntity(SearchEntityDescriptor searchDescriptor,
                            SearchOptions options)

Parameters:

searchDescriptor - The search descriptor of the searched entity

options - The options of the search

Method Detail

validateQuery

protected void validateQuery(SearchOptions options)
                      throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

execute

public void execute()
             throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Specified by:

execute in interface org.bonitasoft.engine.commons.transaction.TransactionContent

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

executeCount

public abstract long executeCount(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                           throws org.bonitasoft.engine.persistence.SBonitaReadException

Execute the count here

Parameters:

queryOptions - The query options to execute the count with

Returns:

The number of result on the server

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

executeSearch

public abstract List<S> executeSearch(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                               throws org.bonitasoft.engine.persistence.SBonitaReadException

Execute the search here

Parameters:

queryOptions - The query options to execute the search with

Returns:

The list of searched server objects

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

convertToClientObjects

public abstract List<C> convertToClientObjects(List<S> serverObjects)
                                        throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Must convert server objects in client objects here

Parameters:

serverObjects - The server object to convert

Returns:

The list of the client objects corresponding to the server objects

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

getResult

public SearchResult<C> getResult()

Specified by:

getResult in interface org.bonitasoft.engine.commons.transaction.TransactionContentWithResult<SearchResult<C extends Serializable>>

getSearchFilter

protected SearchFilter getSearchFilter(SearchOptions searchOptions,
                                       String searchedKey)