Interface ISearchTermHandler

All Known Subinterfaces:
IExtractSearchTermsParams<Model>, IGetFilterCriteriaForEntitiesParams, IGetFilterCriteriaForObjectsParams, ITriggerFilterCriteriaForEventParams
All Known Implementing Classes:
ExtractSearchTermsParams, FilterCriteriaForEventParams, GetFilterCriteriaForEntitiesParams, GetFilterCriteriaForObjectsParams
public interface ISearchTermHandler
Provides basic convenience methods for working with search terms of workflow elements. These methods are optional, but make sure you keep to the default conventions.
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • entitySearchTerm

      @Deprecated default String entitySearchTerm(Class<? extends IUUIDEntity> entityClass)
      Deprecated.
      Use objectSearchTerm(IObjectReference).
      Helper method for the default search term name used to store references to entities.
      Parameters:
      entityClass - Type of the referenced entity.
      Returns:
      The name of the search term for an entity reference of the given type.

    • entitySearchTerm

      @Deprecated default String entitySearchTerm(de.xima.cmn.dao.interfaces.IEntity<Long> entity)
      Deprecated.
      Use objectSearchTerm(IObjectReference).
      Helper method for the default search term name used to store references to entities.
      Parameters:
      entity - Referenced entity.
      Returns:
      The name of the search term for an entity reference for the given entity.

    • entitySearchTerm

      @Deprecated default String entitySearchTerm(IEntityReference reference)
      Deprecated.
      Use objectSearchTerm(IObjectReference).
      Helper method for the default search term name used to store references to entities.
      Parameters:
      reference - Referenced entity.
      Returns:
      The name of the search term for the given entity reference.

    • entitySearchTerms

      @Deprecated default Map<String, List<String>> entitySearchTerms(IEntityReference reference)
      Deprecated.
      Use objectSearchTerms(IObjectReference).
      Helper method for the default search term name used to store references to entities.
      Parameters:
      reference - Referenced entity.
      Returns:
      A new modifiable map prefilled with the search term form the given entity reference.

    • entitySearchTerms

      @Deprecated default Map<String, List<String>> entitySearchTerms(Iterable<? extends IEntityReference> references)
      Deprecated.
      Use objectSearchTerms(Iterable).
      Helper method for the default search term name used to store references to entities.
      Parameters:
      references - Referenced entities.
      Returns:
      A new modifiable map prefilled with the search terms form the given entity references.

    • entitySearchTerms

      @Deprecated default Map<String, List<String>> entitySearchTerms(String searchTermName, IEntityReference reference)
      Deprecated.
      Use objectSearchTerms(String, IObjectReference).
      Helper method for the default search term name used to store references to entities.
      Parameters:
      searchTermName - Custom name for the search term.
      reference - Referenced entity name.
      Returns:
      A new modifiable map prefilled with the search term for the given entity reference.

    • entitySearchTerms

      @Deprecated default Map<String, List<String>> entitySearchTerms(String searchTermName, Iterable<? extends IEntityReference> references)
      Deprecated.
      Use objectSearchTerms(String, Iterable).
      Helper method for the default search term name used to store references to entities.
      Parameters:
      searchTermName - Custom name for the search term.
      references - Referenced entities.
      Returns:
      A new modifiable map prefilled with the search terms form the given entity references.

    • idList

      default List<String> idList(Iterable<? extends IObjectReference> references)
      Parameters:
      references - Object references to process.
      Returns:
      A list of stringified IDs of the given object references.

    • nodeSearchTermExists

      default de.xima.cmn.criteria.FilterCriterion nodeSearchTermExists(String key, de.xima.cmn.criteria.FilterCriterion... moreFilters)
      Parameters:
      key - Key to match.
      moreFilters - Additional filters to chain via AND to the created filter. The filters must be relative to the node search term entity.
      Returns:
      A new filter criterion for checking whether a node search term with the given key exists.

    • nodeSearchTermExists

      default de.xima.cmn.criteria.FilterCriterion nodeSearchTermExists(String key, String value)
      Parameters:
      key - Key to match.
      value - Value to match.
      Returns:
      A new filter criterion for checking whether a node search term with the given key exists and is mapped to the given value.

    • nodeSearchTermNotExists

      default de.xima.cmn.criteria.FilterCriterion nodeSearchTermNotExists(String key, de.xima.cmn.criteria.FilterCriterion... moreFilters)
      Parameters:
      key - Key to match.
      moreFilters - Additional filters to chain via AND to the created filter. The filters must be relative to the node search term entity.
      Returns:
      A new filter criterion for checking whether no node search term with the given key exists.

    • nodeSearchTermNotExists

      default de.xima.cmn.criteria.FilterCriterion nodeSearchTermNotExists(String key, String value)
      Parameters:
      key - Key to match.
      value - Value to match.
      Returns:
      A new filter criterion for checking whether no node search term with the given key exists and is mapped to the given value.

    • objectSearchTerm

      default String objectSearchTerm(IObjectReference reference)
      Helper method for the default search term name used to store references to objects.
      Parameters:
      reference - Referenced object.
      Returns:
      The name of the search term for the given object reference.

    • objectSearchTerms

      default Map<String, List<String>> objectSearchTerms(IObjectReference reference)
      Helper method for the default search term name used to store references to objects.
      Parameters:
      reference - Referenced object.
      Returns:
      A new modifiable map prefilled with the search term form the given object reference.

    • objectSearchTerms

      default Map<String, List<String>> objectSearchTerms(Iterable<? extends IObjectReference> references)
      Helper method for the default search term name used to store references to objects.
      Parameters:
      references - Referenced objects.
      Returns:
      A new modifiable map prefilled with the search terms form the given object references.

    • objectSearchTerms

      default Map<String, List<String>> objectSearchTerms(String searchTermName, IObjectReference reference)
      Helper method for the default search term name used to store references to objects.
      Parameters:
      searchTermName - Custom name for the search term.
      reference - Referenced object name.
      Returns:
      A new modifiable map prefilled with the search term for the given object reference.

    • objectSearchTerms

      default Map<String, List<String>> objectSearchTerms(String searchTermName, Iterable<? extends IObjectReference> references)
      Helper method for the default search term name used to store references to objects.
      Parameters:
      searchTermName - Custom name for the search term.
      references - Referenced objects.
      Returns:
      A new modifiable map prefilled with the search terms form the given objects references.

    • putEntitySearchTerm

      @Deprecated default void putEntitySearchTerm(Map<String, List<String>> searchTerms, IEntityReference reference)
      Deprecated.
      Use putObjectSearchTerm(Map, IObjectReference).
      Helper method that adds the search term for a referenced entity to the given map.
      Parameters:
      searchTerms - Map of search terms to modify.
      reference - Referenced entity.

    • putEntitySearchTerm

      default void putEntitySearchTerm(Map<String, List<String>> searchTerms, IMultiFileProviding multiFile)
      Helper method that adds the search term for the referenced entities to the given map.
      Parameters:
      searchTerms - Map of search terms to modify.
      multiFile - Multi file with referenced entities.

    • putEntitySearchTerm

      default void putEntitySearchTerm(Map<String, List<String>> searchTerms, ISingleFileProviding singleFile)
      Helper method that adds the search term for the referenced entities to the given map.
      Parameters:
      searchTerms - Map of search terms to modify.
      singleFile - Single file with referenced entities.

    • putEntitySearchTerms

      @Deprecated default void putEntitySearchTerms(Map<String, List<String>> searchTerms, Iterable<? extends IEntityReference> references)
      Deprecated.
      Use putObjectSearchTerms(Map, Iterable).
      Helper method that adds the search terms for a referenced entities to the given map.
      Parameters:
      searchTerms - Map of search terms to modify.
      references - Referenced entities.

    • putObjectSearchTerm

      default void putObjectSearchTerm(Map<String, List<String>> searchTerms, IObjectReference reference)
      Helper method that adds the search term for a referenced object to the given map.
      Parameters:
      searchTerms - Map of search terms to modify.
      reference - Referenced object.

    • putObjectSearchTerms

      default void putObjectSearchTerms(Map<String, List<String>> searchTerms, Iterable<? extends IObjectReference> references)
      Helper method that adds the search terms for a referenced objects to the given map.
      Parameters:
      searchTerms - Map of search terms to modify.
      references - Referenced objects.

    • searchTerms

      default Map<String, List<String>> searchTerms(String searchTermName, String searchTermValue)
      Parameters:
      searchTermName - Name of the search term.
      searchTermValue - Value of the search term.
      Returns:
      A new modifiable map prefilled with the given search term.

    • triggerSearchTermExists

      default de.xima.cmn.criteria.FilterCriterion triggerSearchTermExists(String key, de.xima.cmn.criteria.FilterCriterion... moreFilters)
      Parameters:
      key - Key to match.
      moreFilters - Additional filters to chain via AND to the created filter. The filters must be relative to the trigger search term entity.
      Returns:
      A new filter criterion for checking whether a trigger search term with the given key exists.

    • triggerSearchTermExists

      default de.xima.cmn.criteria.FilterCriterion triggerSearchTermExists(String key, String value)
      Parameters:
      key - Key to match.
      value - Value to match.
      Returns:
      A new filter criterion for checking whether a trigger search term with the given key exists and is mapped to the given value.

    • triggerSearchTermNotExists

      default de.xima.cmn.criteria.FilterCriterion triggerSearchTermNotExists(String key, de.xima.cmn.criteria.FilterCriterion... moreFilters)
      Parameters:
      key - Key to match.
      moreFilters - Additional filters to chain via AND to the created filter. The filters must be relative to the trigger search term entity.
      Returns:
      A new filter criterion for checking whether no trigger search term with the given key exists.

    • triggerSearchTermNotExists

      default de.xima.cmn.criteria.FilterCriterion triggerSearchTermNotExists(String key, String value)
      Parameters:
      key - Key to match.
      value - Value to match.
      Returns:
      A new filter criterion for checking whether no trigger search term with the given key exists and is mapped to the given value.

    • uuidList

      @Deprecated default List<String> uuidList(Iterable<? extends IEntityReference> references)
      Deprecated.
      Use idList(Iterable).
      Parameters:
      references - Entity references to process.
      Returns:
      A list of stringified UUIDs of the given entity references.