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, SearchEventTriggerInstanceDescriptor, SearchFlowNodeInstanceDescriptor, SearchFormMappingDescriptor, SearchGroupDescriptor, SearchHumanTaskInstanceDescriptor, SearchMessageInstanceDescriptor, SearchPageDescriptor, SearchProcessDefinitionsDescriptor, SearchProcessInstanceDescriptor, SearchProcessSupervisorDescriptor, SearchProfileDescriptor, SearchProfileMemberGroupDescriptor, SearchProfileMemberRoleAndGroupDescriptor, SearchProfileMemberRoleDescriptor, SearchProfileMemberUserDescriptor, SearchRoleDescriptor, SearchUserDescriptor, SearchWaitingEventSerchDescriptor

public abstract class SearchEntityDescriptor extends Object
Author:
Matthieu Chaffotte, Celine Souchet
  • Constructor Details

    • SearchEntityDescriptor

      public SearchEntityDescriptor()
  • Method Details

    • 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(String searchString)
    • getEntityKeys

      protected abstract Map<String,FieldDescriptor> getEntityKeys()
    • getAllFields

      protected abstract Map<Class<? extends PersistentObject>,Set<String>> getAllFields()
    • convertFilterValue

      protected Serializable convertFilterValue(String filterField, 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)