Filter

java.lang.Object
- com.aspose.tasks.Filter

All Implemented Interfaces:: com.aspose.ms.System.IEquatable<Filter>, Comparable<Filter>

public final class Filter
extends Object
implements Comparable<Filter>, com.aspose.ms.System.IEquatable<Filter>

Represents a filter in Project.

Constructor Summary

Constructors
Constructor Description

Filter()

Constructors
Constructor	Description
`Filter()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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(Filter other)`	Returns a value indicating whether this instance is equal to the specified AssignmentBaseline object.
`boolean`	`equals(Object obj)`	Returns a value indicating whether this instance is equal to the specified AssignmentBaseline 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 value for the filter.
`static boolean`	`op_Equality(Filter a, Filter b)`	Returns a value indicating whether this instance is equal to a specified object.
`static boolean`	`op_GreaterThan(Filter a, Filter b)`	Returns a value indicating whether this instance is greater than a specified object.
`static boolean`	`op_GreaterThanOrEqual(Filter a, Filter b)`	Returns a value indicating whether this instance is greater than or equal to a specified object.
`static boolean`	`op_Inequality(Filter a, Filter b)`	Returns a value indicating whether this instance is not equal to a specified object.
`static boolean`	`op_LessThan(Filter a, Filter b)`	Returns a value indicating whether this instance is less than a specified object.
`static boolean`	`op_LessThanOrEqual(Filter a, Filter b)`	Returns a value indicating whether this instance is less than or equal to a specified object.
`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- 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.
  - equals
```
public final boolean equals(Filter other)
```
    Returns a value indicating whether this instance is equal to the specified AssignmentBaseline object.
    
    Parameters:
    
    other - the specified AssignmentBaseline object to compare with this instance.
    
    Returns:
    
    returns true if this instance is equal to the specified AssignmentBaseline object; otherwise, false.
  - equals
```
public boolean equals(Object obj)
```
    Returns a value indicating whether this instance is equal to the specified AssignmentBaseline object.
    
    Specified by:
    
    equals in interface com.aspose.ms.System.IEquatable<Filter>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the specified AssignmentBaseline object to compare with this instance.
    
    Returns:
    
    returns true if this instance is equal to the specified AssignmentBaseline object; otherwise, false.
  - 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.
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for the filter.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    returns a hash code value for this object.
  - op_Equality
```
public static boolean op_Equality(Filter a,
                                  Filter b)
```
    Returns a value indicating whether this instance is equal to a specified object.
    
    Parameters:
    
    a - The first filter.
    
    b - The second filter.
    
    Returns:
    
    a value indicating whether this instance is equal to a specified object
  - op_GreaterThan
```
public static boolean op_GreaterThan(Filter a,
                                     Filter b)
```
    Returns a value indicating whether this instance is greater than a specified object.
    
    Parameters:
    
    a - The first filter.
    
    b - The second filter.
    
    Returns:
    
    a value indicating whether this instance is greater than a specified object
  - op_GreaterThanOrEqual
```
public static boolean op_GreaterThanOrEqual(Filter a,
                                            Filter b)
```
    Returns a value indicating whether this instance is greater than or equal to a specified object.
    
    Parameters:
    
    a - The first filter.
    
    b - The second filter.
    
    Returns:
    
    a value indicating whether this instance is greater than or equal to a specified object
  - op_Inequality
```
public static boolean op_Inequality(Filter a,
                                    Filter b)
```
    Returns a value indicating whether this instance is not equal to a specified object.
    
    Parameters:
    
    a - The first filter.
    
    b - The second filter.
    
    Returns:
    
    a value indicating whether this instance is not equal to a specified object
  - op_LessThan
```
public static boolean op_LessThan(Filter a,
                                  Filter b)
```
    Returns a value indicating whether this instance is less than a specified object.
    
    Parameters:
    
    a - The first filter.
    
    b - The second filter.
    
    Returns:
    
    a value indicating whether this instance is less than a specified object
  - op_LessThanOrEqual
```
public static boolean op_LessThanOrEqual(Filter a,
                                         Filter b)
```
    Returns a value indicating whether this instance is less than or equal to a specified object.
    
    Parameters:
    
    a - The first filter.
    
    b - The second filter.
    
    Returns:
    
    a value indicating whether this instance is less than or equal to a specified object

com.aspose.tasks

Interfaces

Classes

Exceptions

Class Filter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

compareTo

equals

equals

getCriteria

setCriteria

getFilterType

getIndex

getName

setName

getParentProject

getShowInMenu

setShowInMenu

getShowRelatedSummaryRows

setShowRelatedSummaryRows

getUid

hashCode

op_Equality

op_GreaterThan

op_GreaterThanOrEqual

op_Inequality

op_LessThan

op_LessThanOrEqual