Package com.aspose.tasks

Class FilterCriteria

  • public class FilterCriteria
extends Object

    Defines the criteria that tasks or resources must meet to be displayed in MSP view.

    • Constructor Summary

      Constructors 
      Constructor Description
      FilterCriteria()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      List<FilterCriteria> getCriteriaRows()
      Gets the list of child FilterCriteria rows.
      int getField()
      Gets a Field(getField()/setField(int)) to change.
      int getOperation()
      Gets the criterion established with FieldName, Test, and Value relates to other criteria in the filter.
      int getTest()
      Gets the type of comparison made between FieldName and Value that acts as selection criteria for the filter.
      Object[] getValues()
      Gets the object values to compare with the value of the field specified with FieldName.
      boolean isValueAField()
      Gets whether the right-hand value of FilterCriteria is a field reference, not a constant value.
      boolean isValueAField​(int index)
      Gets whether the value at the index of FilterCriteria is a field reference, not a constant value.
      void setField​(int value)
      Sets a Field(getField()/setField(int)) to change.
      void setOperation​(int value)
      Sets the criterion established with FieldName, Test, and Value relates to other criteria in the filter.
      void setTest​(int value)
      Sets the type of comparison made between FieldName and Value that acts as selection criteria for the filter.
      void setValue​(int index, Object value)
      Sets the object value at the index to compare with the value of the field specified by FieldName.
      void setValue​(Object value)
      Sets the object value to compare with the value of the field specified by FieldName.
      void setValueByField​(int value)
      Sets the field whose value will be compared with the value of the field specified by FieldName.
      void setValueByField​(int index, int value)
      Sets the field at the index whose value will be compared with the value of the field specified by FieldName.
      String toString()
      Returns string representation of the instance of the FilterCriteria class.

    • Constructor Detail

      • FilterCriteria

        public FilterCriteria()

    • Method Detail

      • getCriteriaRows

        public final List<FilterCriteria> getCriteriaRows()

        Gets the list of child FilterCriteria rows. If the filter contains more than one criterion row then the effect of an And operator is that the criteria for both rows must be met for the task or resource to be displayed as a result of this filter. The effect of an Or operator is that the criteria for one or the other row must be met.

        Returns:
        the list of child FilterCriteria rows.

      • getOperation

        public final int getOperation()

        Gets the criterion established with FieldName, Test, and Value relates to other criteria in the filter.

        Returns:
        the criterion established with FieldName, Test, and Value relates to other criteria in the filter.

      • setOperation

        public final void setOperation​(int value)

        Sets the criterion established with FieldName, Test, and Value relates to other criteria in the filter.

        Parameters:
        value - the criterion established with FieldName, Test, and Value relates to other criteria in the filter.

      • getTest

        public final int getTest()

        Gets the type of comparison made between FieldName and Value that acts as selection criteria for the filter. FilterComparisonType

        Returns:
        the type of comparison made between FieldName and Value that acts as selection criteria for the filter.

      • setTest

        public final void setTest​(int value)

        Sets the type of comparison made between FieldName and Value that acts as selection criteria for the filter. FilterComparisonType

        Parameters:
        value - the type of comparison made between FieldName and Value that acts as selection criteria for the filter.

      • getValues

        public final Object[] getValues()

        Gets the object values to compare with the value of the field specified with FieldName.

        Returns:
        the object values to compare with the value of the field specified with FieldName.

      • isValueAField

        public final boolean isValueAField()

        Gets whether the right-hand value of FilterCriteria is a field reference, not a constant value.

        Returns:
        whether the right-hand value of FilterCriteria is a field reference, not a constant value.

      • isValueAField

        public final boolean isValueAField​(int index)

        Gets whether the value at the index of FilterCriteria is a field reference, not a constant value.

        Parameters:
        index - the index of the value
        Returns:
        whether the right-hand value at the index of FilterCriteria is a field reference, not a constant value.

      • setValue

        public final void setValue​(Object value)

        Sets the object value to compare with the value of the field specified by FieldName.

        Parameters:
        value - object value which will serve as right-hand value of filter criteria.

      • setValue

        public final void setValue​(int index,
                           Object value)

        Sets the object value at the index to compare with the value of the field specified by FieldName.

        Parameters:
        index - the index of the value.
        value - object value which will serve as right-hand value at the index of filter criteria.

      • setValueByField

        public final void setValueByField​(int value)

        Sets the field whose value will be compared with the value of the field specified by FieldName.

        Parameters:
        value - Field which will serve as right-hand value of filter criteria.

      • setValueByField

        public final void setValueByField​(int index,
                                  int value)

        Sets the field at the index whose value will be compared with the value of the field specified by FieldName.

        Parameters:
        index - the index of the value
        value - Field which will serve as right-hand value at the index of filter criteria.

      • toString

        public String toString()

        Returns string representation of the instance of the FilterCriteria class.

        Overrides:
        toString in class Object
        Returns:
        string representation of this object.