org.bonitasoft.engine.search.descriptor

Class SearchEntityDescriptor

java.lang.Object

org.bonitasoft.engine.search.descriptor.SearchEntityDescriptor

Direct Known Subclasses:

SearchActivityInstanceDescriptor, SearchApplicationDescriptor, SearchApplicationMenuDescriptor, SearchApplicationPageDescriptor, SearchArchivedActivityInstanceDescriptor, SearchArchivedCommentsDescriptor, SearchArchivedConnectorInstanceDescriptor, SearchArchivedDocumentDescriptor, SearchArchivedFlowNodeInstanceDescriptor, SearchArchivedHumanTaskInstanceDescriptor, SearchArchivedProcessInstancesDescriptor, SearchCommandDescriptor, SearchCommentDescriptor, SearchConnectorInstanceDescriptor, SearchCustomUserInfoValueDescriptor, SearchDocumentDescriptor, SearchEntityMemberDescriptor, SearchEventTriggerInstanceDescriptor, SearchFlowNodeInstanceDescriptor, SearchFormMappingDescriptor, SearchGroupDescriptor, SearchHumanTaskInstanceDescriptor, SearchMessageInstanceDescriptor, SearchPageDescriptor, SearchProcessDefinitionsDescriptor, SearchProcessInstanceDescriptor, SearchProcessSupervisorDescriptor, SearchProfileDescriptor, SearchProfileEntryDescriptor, SearchProfileMemberGroupDescriptor, SearchProfileMemberRoleAndGroupDescriptor, SearchProfileMemberRoleDescriptor, SearchProfileMemberUserDescriptor, SearchRoleDescriptor, SearchThemeDescriptor, SearchUserDescriptor, SearchWaitingEventSerchDescriptor

public abstract class SearchEntityDescriptor
extends java.lang.Object

Author:

Matthieu Chaffotte, Celine Souchet

Constructor Summary

Constructors

Constructor and Description
SearchEntityDescriptor()

Method Summary

Modifier and Type	Method and Description
FilterOption	constructFilterOption(org.bonitasoft.engine.search.impl.SearchFilter filter, FieldDescriptor fieldDescriptor)
protected java.io.Serializable	convertFilterValue(java.lang.String filterField, java.io.Serializable filterValue) Override this method to have specific conversion behavior from client filter value to server filter value .
protected abstract java.util.Map<java.lang.Class<? extends PersistentObject>,java.util.Set<java.lang.String>>	getAllFields()
FilterOption	getEntityFilter(org.bonitasoft.engine.search.impl.SearchFilter filter)
protected abstract java.util.Map<java.lang.String,FieldDescriptor>	getEntityKeys()
OrderByOption	getEntityOrder(org.bonitasoft.engine.search.Sort sort)
SearchFields	getEntitySearchTerm(java.lang.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 FilterOption getEntityFilter(org.bonitasoft.engine.search.impl.SearchFilter filter)

getEntityOrder

public OrderByOption getEntityOrder(org.bonitasoft.engine.search.Sort sort)
                             throws SBonitaReadException

Throws:

SBonitaReadException

getEntitySearchTerm

public SearchFields getEntitySearchTerm(java.lang.String searchString)

getEntityKeys

protected abstract java.util.Map<java.lang.String,FieldDescriptor> getEntityKeys()

getAllFields

protected abstract java.util.Map<java.lang.Class<? extends PersistentObject>,java.util.Set<java.lang.String>> getAllFields()

convertFilterValue

protected java.io.Serializable convertFilterValue(java.lang.String filterField,
                                                  java.io.Serializable filterValue)

Override this method to have specific conversion behavior from client filter value to server filter value .

Parameters:

filterField - The field to filter

filterValue - The initial value

Returns:

the converted filter value

Since:

6.4.0

constructFilterOption

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