Package com.smartgwt.client.widgets

Class DataContextCriteriaSettings

java.lang.Object
com.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.widgets.DataContextCriteriaSettings
All Implemented Interfaces:
HasHandlers
public class DataContextCriteriaSettings extends DataClass
A contribution to the shared criteria of a Canvas.dataContext, published with Canvas.setDataContextCriteria(): up to three sets of criteria, the DataSources they apply to, and an envelope describing the contributor.
See Also:

  • Constructor Details

    • DataContextCriteriaSettings

      public DataContextCriteriaSettings()

    • DataContextCriteriaSettings

      public DataContextCriteriaSettings(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static DataContextCriteriaSettings getOrCreateRef(JavaScriptObject jsObj)

    • setAfterCriteria

      public DataContextCriteriaSettings setAfterCriteria(Criteria afterCriteria)
      Criteria on totals, applied as DSRequest.afterCriteria by each component the contribution applies to whose request can interpret them. See Canvas.setDataContextCriteria().
      Parameters:
      afterCriteria - New afterCriteria value. Default value is null
      Returns:
      DataContextCriteriaSettings instance, for chaining setter calls

    • getAfterCriteria

      public Criteria getAfterCriteria()
      Criteria on totals, applied as DSRequest.afterCriteria by each component the contribution applies to whose request can interpret them. See Canvas.setDataContextCriteria().
      Returns:
      Current afterCriteria value. Default value is null

    • setBeforeCriteria

      public DataContextCriteriaSettings setBeforeCriteria(Criteria beforeCriteria)
      Criteria on the records, applied by each component the contribution applies to as DSRequest.beforeCriteria. See Canvas.setDataContextCriteria().
      Parameters:
      beforeCriteria - New beforeCriteria value. Default value is null
      Returns:
      DataContextCriteriaSettings instance, for chaining setter calls

    • getBeforeCriteria

      public Criteria getBeforeCriteria()
      Criteria on the records, applied by each component the contribution applies to as DSRequest.beforeCriteria. See Canvas.setDataContextCriteria().
      Returns:
      Current beforeCriteria value. Default value is null

    • setContributorID

      public DataContextCriteriaSettings setContributorID(String contributorID)
      Unique identifier for the criteria source. When multiple independent components (such as Slicers) each publish criteria for the same DataSource, pass a distinct contributorID per source; all contributors' criteria are AND-combined automatically. Without one, each call to Canvas.setDataContextCriteria() replaces the previous anonymous contribution for the same DataSources. Applies only to contributions that name a dataSource; with none, criteria go to the single global slot and the contributorID is ignored.
      Parameters:
      contributorID - New contributorID value. Default value is null
      Returns:
      DataContextCriteriaSettings instance, for chaining setter calls

    • getContributorID

      public String getContributorID()
      Unique identifier for the criteria source. When multiple independent components (such as Slicers) each publish criteria for the same DataSource, pass a distinct contributorID per source; all contributors' criteria are AND-combined automatically. Without one, each call to Canvas.setDataContextCriteria() replaces the previous anonymous contribution for the same DataSources. Applies only to contributions that name a dataSource; with none, criteria go to the single global slot and the contributorID is ignored.
      Returns:
      Current contributorID value. Default value is null

    • setCriteria

      public DataContextCriteriaSettings setCriteria(Criteria criteria)
      Ordinary criteria, combined into the criteria of each component the contribution applies to. See Canvas.setDataContextCriteria() for how they differ from beforeCriteria and afterCriteria.
      Parameters:
      criteria - New criteria value. Default value is null
      Returns:
      DataContextCriteriaSettings instance, for chaining setter calls

    • getCriteria

      public Criteria getCriteria()
      Ordinary criteria, combined into the criteria of each component the contribution applies to. See Canvas.setDataContextCriteria() for how they differ from beforeCriteria and afterCriteria.
      Returns:
      Current criteria value. Default value is null

    • setDataSource

      public DataContextCriteriaSettings setDataSource(String dataSource)
      ID of the DataSource the contribution applies to, or an Array of IDs. When omitted, the contribution's criteria apply to every DataSource by field-name match - see Canvas.setDataContextCriteria().
      Parameters:
      dataSource - New dataSource value. Default value is null
      Returns:
      DataContextCriteriaSettings instance, for chaining setter calls

    • getDataSource

      public String getDataSource()
      ID of the DataSource the contribution applies to, or an Array of IDs. When omitted, the contribution's criteria apply to every DataSource by field-name match - see Canvas.setDataContextCriteria().
      Returns:
      Current dataSource value. Default value is null

    • setDataSource

      public DataContextCriteriaSettings setDataSource(String... dataSource)
      ID of the DataSource the contribution applies to, or an Array of IDs. When omitted, the contribution's criteria apply to every DataSource by field-name match - see Canvas.setDataContextCriteria().
      Parameters:
      dataSource - New dataSource value. Default value is null
      Returns:
      DataContextCriteriaSettings instance, for chaining setter calls

    • getDataSourceAsStringArray

      public String[] getDataSourceAsStringArray()
      ID of the DataSource the contribution applies to, or an Array of IDs. When omitted, the contribution's criteria apply to every DataSource by field-name match - see Canvas.setDataContextCriteria().
      Returns:
      Current dataSource value. Default value is null

    • setFilterRelated

      public DataContextCriteriaSettings setFilterRelated(Boolean filterRelated)
      When true, components bound to DataSources that have a DataSourceField.foreignKey relationship to the target DataSource are also filtered, via a valueQuery sub-criterion on their foreign-key column: the contribution's criteria and beforeCriteria become criteria of the same kind there. Its afterCriteria test totals of the target DataSource's fields, which a related component does not produce, so they do not cascade. Only supported when dataSource names a single DataSource.
      Parameters:
      filterRelated - New filterRelated value. Default value is false
      Returns:
      DataContextCriteriaSettings instance, for chaining setter calls

    • getFilterRelated

      public Boolean getFilterRelated()
      When true, components bound to DataSources that have a DataSourceField.foreignKey relationship to the target DataSource are also filtered, via a valueQuery sub-criterion on their foreign-key column: the contribution's criteria and beforeCriteria become criteria of the same kind there. Its afterCriteria test totals of the target DataSource's fields, which a related component does not produce, so they do not cascade. Only supported when dataSource names a single DataSource.
      Returns:
      Current filterRelated value. Default value is false