Package com.flowable.platform.api.repository

Interface QueryDefinitionModel

All Known Implementing Classes:
BaseQueryDefinitionModel
public interface QueryDefinitionModel

  • Method Details

    • getKey

      String getKey()
      Returns the business key usually used to reference or lookup a query definition regardless of its version.

    • getName

      String getName()
      Returns the name of this query definition.

    • getDescription

      String getDescription()
      Returns the optional description of this query definition, describing where and how it might be used.

    • getSourceIndex

      String getSourceIndex()
      Returns the name of the index on which the query will be performed on.

    • getType

      String getType()
      Allows to distinguish between different types of query models

    • getSubType

      String getSubType()
      See Also:

    • getCustomFilter

      com.fasterxml.jackson.databind.JsonNode getCustomFilter()
      Returns the JsonNode that will be used as input to compose a safe ES query.

    • getTemplateFilter

      String getTemplateFilter()
      Returns the template content that will be used to first parse by a template engine and then use as input to compose a safe ES query.

    • getTemplateResource

      String getTemplateResource()
      Returns the resource that will be used to parse to a ES query by a template engine.

    • getTemplateContent

      String getTemplateContent()
      Returns the template content that will be used to parse to a ES query by a template engine.

    • getParameters

      Map<String,QueryParameter> getParameters()
      A query can have 0 or more parameters that are resolved at runtime.

    • getSortParameters

      Map<String,QuerySortParameter> getSortParameters()
      Besides regular parameters, a query can expose parameters used specifically for sorting.

    • getConfiguration

      com.fasterxml.jackson.databind.JsonNode getConfiguration()
      A configuration field that can be used for various use cases not covered by the other fields.

    • getStandardDataQueryConfiguration

      StandardDataQueryConfiguration getStandardDataQueryConfiguration()
      Returns the parsed Java version of the getConfiguration(). Only non-null when isQueryBuilderQuery() is true.

    • isCustomQueryTemplateQueryModel

      default boolean isCustomQueryTemplateQueryModel()

    • isSafeQueryTemplateQueryModel

      default boolean isSafeQueryTemplateQueryModel()

    • isLegacyQueryModelWithTemplateResource

      default boolean isLegacyQueryModelWithTemplateResource()

    • isQueryBuilderQuery

      default boolean isQueryBuilderQuery()