com.aspose.tasks

Interfaces

Classes

Exceptions

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)
      Returns a value indicating whether this instance is greater or less than a specified object.
      boolean equals(Object obj)
      Returns a value indicating whether this instance is equal to a specified object.
      FilterCriteria getCriteria()
      Gets a 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 a name of a Filter object.
      Project getParentProject()
      Gets the parent of the Filter object.
      boolean getShowInMenu()
      Gets true if Project shows the filter name in the Filter drop-down list on the View tab of the Ribbon; otherwise, false.
      boolean getShowRelatedSummaryRows()
      Gets true if related summary rows are to be 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 a criteria that tasks or resources must meet to be displayed in MSP view.
      void setName(String value)
      Sets a name of a Filter object.
      void setShowInMenu(boolean value)
      Set to true if Project shows the filter name in the Filter drop-down list on the View tab of the Ribbon; otherwise, false.
      void setShowRelatedSummaryRows(boolean value)
      Set to true if related summary rows are to be displayed for the filter.
    • Constructor Detail

      • Filter

        public Filter()
    • Method Detail

      • getCriteria

        public FilterCriteria getCriteria()

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

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

        public void setCriteria(FilterCriteria value)
        Sets a criteria that tasks or resources must meet to be displayed in MSP view.
        Parameters:
        value - a criteria that tasks or resources must meet to be displayed in MSP view.
      • getFilterType

        public int getFilterType()

        Gets the type of the filter. Read-only ItemType.

        Returns:
        filter type.
      • getIndex

        public int getIndex()

        Gets the index of a Filter object in the Filters containing object. Read-only int.

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

        public String getName()

        Gets a name of a Filter object. Read/write string.

        Returns:
        a name of a Filter object.
      • setName

        public void setName(String value)
        Sets a name of a Filter object.
        Parameters:
        value - a name of a Filter object.
      • getParentProject

        public Project getParentProject()

        Gets the parent of the Filter object. Read-only Project.

        Returns:
        parent project.
      • getShowInMenu

        public boolean getShowInMenu()

        Gets true if Project shows the filter name in the Filter drop-down list on the View tab of the Ribbon; otherwise, false. Read/write Boolean.

        Returns:
        true if Project shows the filter name in the Filter drop-down list on the View tab of the Ribbon; otherwise, false.
      • setShowInMenu

        public void setShowInMenu(boolean value)
        Set to true if Project shows the filter name in the Filter drop-down list on the View tab of the Ribbon; otherwise, false.
        Parameters:
        value - true if Project shows the filter name in the Filter drop-down list on the View tab of the Ribbon; otherwise, false.
      • getShowRelatedSummaryRows

        public boolean getShowRelatedSummaryRows()

        Gets true if related summary rows are to be displayed for the filter. Read/write Boolean.

        Returns:
        true if related summary rows are to be displayed for the filter; otherwise, false.
      • setShowRelatedSummaryRows

        public void setShowRelatedSummaryRows(boolean value)
        Set to true if related summary rows are to be displayed for the filter.
        Parameters:
        value - true if related summary rows are to be displayed for the filter; otherwise, false.
      • getUid

        public int getUid()

        Gets the unique identifier of a filter.

        Returns:
        the unique identifier of a filter.
      • compareTo

        public int compareTo(Filter other)
        Returns a value indicating whether this instance is greater or less than a specified object.
        Specified by:
        compareTo in interface Comparable<Filter>
        Parameters:
        other - The object to compare with this instance.
        Returns:
        1 if other is a Filter with UID which is less than UID of this instance; 0 if other is a Filter that has the same UID; -1 otherwise.
      • 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.