org.bonitasoft.engine.search.descriptor

Class SearchEntityDescriptor

java.lang.Object

org.bonitasoft.engine.search.descriptor.SearchEntityDescriptor

Direct Known Subclasses:

SearchActivityInstanceDescriptor, SearchArchivedActivityInstanceDescriptor, SearchArchivedCommentsDescriptor, SearchArchivedConnectorInstanceDescriptor, SearchArchivedDocumentDescriptor, SearchArchivedFlowElementInstanceDescriptor, SearchArchivedFlowNodeInstanceDescriptor, SearchArchivedHumanTaskInstanceDescriptor, SearchArchivedProcessInstancesDescriptor, SearchCommandDescriptor, SearchCommentDescriptor, SearchConnectorInstanceDescriptor, SearchDocumentDescriptor, SearchEntityMemberDescriptor, SearchFlowNodeInstanceDescriptor, SearchGroupDescriptor, SearchHumanTaskInstanceDescriptor, SearchProcessDefinitionsDescriptor, SearchProcessInstanceDescriptor, SearchProcessSupervisorDescriptor, SearchProfileDescriptor, SearchProfileEntryDescriptor, SearchProfileMemberGroupDescriptor, SearchProfileMemberRoleAndGroupDescriptor, SearchProfileMemberRoleDescriptor, SearchProfileMemberUserDescriptor, SearchRoleDescriptor, SearchThemeDescriptor, SearchUserDescriptor, SearchWaitingEventSerchDescriptor

public abstract class SearchEntityDescriptor
extends Object

Author:

Matthieu Chaffotte

Constructor Summary

Constructors

Constructor and Description
SearchEntityDescriptor()

Method Summary

Methods

Modifier and Type	Method and Description
org.bonitasoft.engine.persistence.FilterOption	constructFilterOption(SearchFilter filter, FieldDescriptor fieldDescriptor)
protected Serializable	convertFilterValue(Serializable filterValue) Override this method to have specific convertion behaviour from client filter value to server filter value .
protected abstract Map<Class<? extends org.bonitasoft.engine.persistence.PersistentObject>,Set<String>>	getAllFields()
org.bonitasoft.engine.persistence.FilterOption	getEntityFilter(SearchFilter filter)
protected abstract Map<String,FieldDescriptor>	getEntityKeys()
org.bonitasoft.engine.persistence.OrderByOption	getEntityOrder(Sort sort)
org.bonitasoft.engine.persistence.SearchFields	getEntitySearchTerm(String searchString)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchEntityDescriptor

public SearchEntityDescriptor()

Method Detail

getEntityFilter

public org.bonitasoft.engine.persistence.FilterOption getEntityFilter(SearchFilter filter)

getEntityOrder

public org.bonitasoft.engine.persistence.OrderByOption getEntityOrder(Sort sort)
                                                               throws org.bonitasoft.engine.persistence.SBonitaSearchException

Throws:

org.bonitasoft.engine.persistence.SBonitaSearchException

getEntitySearchTerm

public org.bonitasoft.engine.persistence.SearchFields getEntitySearchTerm(String searchString)

getEntityKeys

protected abstract Map<String,FieldDescriptor> getEntityKeys()

getAllFields

protected abstract Map<Class<? extends org.bonitasoft.engine.persistence.PersistentObject>,Set<String>> getAllFields()

convertFilterValue

protected Serializable convertFilterValue(Serializable filterValue)

Override this method to have specific convertion behaviour from client filter value to server filter value .

Parameters:

filterValue - the initial value

Returns:

the converted filter value

Since:

6.0

constructFilterOption

public org.bonitasoft.engine.persistence.FilterOption constructFilterOption(SearchFilter filter,
                                                                   FieldDescriptor fieldDescriptor)