com.aspose.tasks

Interfaces

Classes

Exceptions

Skip navigation links
com.aspose.tasks

Class Filter

    • Constructor Summary

      Constructors 
      Constructor and Description
      Filter() 

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int compareTo(Filter other)
      Compares this instance to the specified instance of the Filter class and returns an indication of their relative order.
      boolean equals(Object obj)
      Returns a value indicating whether this instance is equal to a specified object.
      FilterCriteria getCriteria()
      Gets the criteria that tasks or resources must meet to be displayed in MSP view.
      int getFilterType()
      Gets the type of the filter.
      int getIndex()
      Gets the index of a Filter object in the Filters containing object.
      String getName()
      Gets the name of a Filter object.
      Project getParentProject()
      Gets the parent of the Filter object.
      boolean getShowInMenu()
      Gets a value indicating whether project shows the filter name in the Filter drop-down list on the View tab of the Ribbon.
      boolean getShowRelatedSummaryRows()
      Gets a value indicating whether related summary rows are displayed for the filter.
      int getUid()
      Gets the unique identifier of a filter.
      int hashCode()
      Returns a hash code for this Filter.
      void setCriteria(FilterCriteria value)
      Sets the criteria that tasks or resources must meet to be displayed in MSP view.
      void setName(String value)
      Sets the name of a Filter object.
      void setShowInMenu(boolean value)
      Sets a value indicating whether project shows the filter name in the Filter drop-down list on the View tab of the Ribbon.
      void setShowRelatedSummaryRows(boolean value)
      Sets a value indicating whether related summary rows are displayed for the filter.

    • Constructor Detail

      • Filter

        public Filter()

    • Method Detail

      • compareTo

        public final int compareTo(Filter other)

        Compares this instance to the specified instance of the Filter class and returns an indication of their relative order.

        Specified by:
        compareTo in interface Comparable<Filter>
        Parameters:
        other - the specified instance of the Filter class to compare to this object.
        Returns:
        an indication of their relative order.

      • getCriteria

        public final FilterCriteria getCriteria()

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

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

      • setCriteria

        public final void setCriteria(FilterCriteria value)

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

        Parameters:
        value - the criteria that tasks or resources must meet to be displayed in MSP view.

      • getFilterType

        public final int getFilterType()

        Gets the type of the filter.

        Returns:
        the type of the filter.

      • getIndex

        public final int getIndex()

        Gets the index of a Filter object in the Filters containing object.

        Returns:
        the index of a Filter object in the Filters containing object.

      • getName

        public final String getName()

        Gets the name of a Filter object.

        Returns:
        the name of a Filter object.

      • setName

        public final void setName(String value)

        Sets the name of a Filter object.

        Parameters:
        value - the name of a Filter object.

      • getParentProject

        public final Project getParentProject()

        Gets the parent of the Filter object.

        Returns:
        the parent of the Filter object.

      • getShowInMenu

        public final boolean getShowInMenu()

        Gets a value indicating whether project shows the filter name in the Filter drop-down list on the View tab of the Ribbon.

        Returns:
        a value indicating whether project shows the filter name in the Filter drop-down list on the View tab of the Ribbon.

      • setShowInMenu

        public final void setShowInMenu(boolean value)

        Sets a value indicating whether project shows the filter name in the Filter drop-down list on the View tab of the Ribbon.

        Parameters:
        value - a value indicating whether project shows the filter name in the Filter drop-down list on the View tab of the Ribbon.

      • getShowRelatedSummaryRows

        public final boolean getShowRelatedSummaryRows()

        Gets a value indicating whether related summary rows are displayed for the filter.

        Returns:
        a value indicating whether related summary rows are displayed for the filter.

      • setShowRelatedSummaryRows

        public final void setShowRelatedSummaryRows(boolean value)

        Sets a value indicating whether related summary rows are displayed for the filter.

        Parameters:
        value - a value indicating whether related summary rows are displayed for the filter.

      • getUid

        public final int getUid()

        Gets the unique identifier of a filter.

        Returns:
        the unique identifier of a filter.

      • equals

        public boolean equals(Object obj)

        Returns a value indicating whether this instance is equal to a specified object.

        Overrides:
        equals in class Object
        Parameters:
        obj - The object to compare with this instance.
        Returns:
        <b>True</b> if obj is a Filter that has the same UID value as this instance; otherwise, <b>false</b>.

      • hashCode

        public int hashCode()
        Returns a hash code for this Filter.
        Overrides:
        hashCode in class Object
        Returns:
        Returns a hash code value for this object.