Filter
Inheritance: java.lang.Object
All Implemented Interfaces: java.lang.Comparable, com.aspose.ms.System.IEquatable
public final class Filter implements Comparable<Filter>, System.IEquatable<Filter>
Represents a filter in Project.
Constructors
| Constructor | Description |
|---|---|
| Filter() |
Methods
| Method | Description |
|---|---|
| compareTo(Filter other) | Compares this instance to the specified instance of the Filter class and returns an indication of their relative order. |
| equals(Filter other) | Returns a value indicating whether this instance is equal to the specified AssignmentBaseline object. |
| equals(Object obj) | Returns a value indicating whether this instance is equal to the specified AssignmentBaseline object. |
| getCriteria() | Gets the criteria that tasks or resources must meet to be displayed in MSP view. |
| getFilterType() | Gets the type of the filter. |
| getIndex() | Gets the index of a Filter object in the Filters containing object. |
| getName() | Gets the name of a Filter object. |
| getShowInMenu() | Gets a value indicating whether project shows the filter name in the Filter drop-down list on the View tab of the Ribbon. |
| getShowRelatedSummaryRows() | Gets a value indicating whether related summary rows are displayed for the filter. |
| getUid() | Gets the unique identifier of a filter. |
| hashCode() | Returns a hash code value for the filter. |
| op_Equality(Filter a, Filter b) | Returns a value indicating whether this instance is equal to a specified object. |
| op_GreaterThan(Filter a, Filter b) | Returns a value indicating whether this instance is greater than a specified object. |
| op_GreaterThanOrEqual(Filter a, Filter b) | Returns a value indicating whether this instance is greater than or equal to a specified object. |
| op_Inequality(Filter a, Filter b) | Returns a value indicating whether this instance is not equal to a specified object. |
| op_LessThan(Filter a, Filter b) | Returns a value indicating whether this instance is less than a specified object. |
| op_LessThanOrEqual(Filter a, Filter b) | Returns a value indicating whether this instance is less than or equal to a specified object. |
| setCriteria(FilterCriteria value) | Sets the criteria that tasks or resources must meet to be displayed in MSP view. |
| setFilterType(int value) | The type of the filter. |
| setName(String value) | Sets the name of a Filter object. |
| 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. |
| setShowRelatedSummaryRows(boolean value) | Sets a value indicating whether related summary rows are displayed for the filter. |
Filter()
public Filter()
compareTo(Filter other)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| other | Filter | the specified instance of the Filter class to compare to this object. |
Returns: int - an indication of their relative order.
equals(Filter other)
public final boolean equals(Filter other)
Returns a value indicating whether this instance is equal to the specified AssignmentBaseline object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| other | Filter | the specified AssignmentBaseline object to compare with this instance. |
Returns: boolean - returns true if this instance is equal to the specified AssignmentBaseline object; otherwise, false.
equals(Object obj)
public boolean equals(Object obj)
Returns a value indicating whether this instance is equal to the specified AssignmentBaseline object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | java.lang.Object | the specified AssignmentBaseline object to compare with this instance. |
Returns: boolean - 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: FilterCriteria - 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: int - the type of the filter.
getIndex()
public final int getIndex()
Gets the index of a Filter object in the Filters containing object.
Returns: int - the index of a Filter object in the Filters containing object.
getName()
public final String getName()
Gets the name of a Filter object.
Returns: java.lang.String - the name of a 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: boolean - 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: boolean - 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: int - the unique identifier of a filter.
hashCode()
public int hashCode()
Returns a hash code value for the filter.
Returns: int - returns a hash code value for this object.
op_Equality(Filter a, Filter b)
public static boolean op_Equality(Filter a, Filter b)
Returns a value indicating whether this instance is equal to a specified object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| a | Filter | The first filter. |
| b | Filter | The second filter. |
Returns: boolean - a value indicating whether this instance is equal to a specified object
op_GreaterThan(Filter a, Filter b)
public static boolean op_GreaterThan(Filter a, Filter b)
Returns a value indicating whether this instance is greater than a specified object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| a | Filter | The first filter. |
| b | Filter | The second filter. |
Returns: boolean - a value indicating whether this instance is greater than a specified object
op_GreaterThanOrEqual(Filter a, Filter b)
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:
| Parameter | Type | Description |
|---|---|---|
| a | Filter | The first filter. |
| b | Filter | The second filter. |
Returns: boolean - a value indicating whether this instance is greater than or equal to a specified object
op_Inequality(Filter a, Filter b)
public static boolean op_Inequality(Filter a, Filter b)
Returns a value indicating whether this instance is not equal to a specified object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| a | Filter | The first filter. |
| b | Filter | The second filter. |
Returns: boolean - a value indicating whether this instance is not equal to a specified object
op_LessThan(Filter a, Filter b)
public static boolean op_LessThan(Filter a, Filter b)
Returns a value indicating whether this instance is less than a specified object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| a | Filter | The first filter. |
| b | Filter | The second filter. |
Returns: boolean - a value indicating whether this instance is less than a specified object
op_LessThanOrEqual(Filter a, Filter b)
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:
| Parameter | Type | Description |
|---|---|---|
| a | Filter | The first filter. |
| b | Filter | The second filter. |
Returns: boolean - a value indicating whether this instance is less than or equal to a specified object
setCriteria(FilterCriteria value)
public final void setCriteria(FilterCriteria value)
Sets the criteria that tasks or resources must meet to be displayed in MSP view.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | FilterCriteria | the criteria that tasks or resources must meet to be displayed in MSP view. |
setFilterType(int value)
public final void setFilterType(int value)
The type of the filter.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | the type of the filter. |
setName(String value)
public final void setName(String value)
Sets the name of a Filter object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | the name of a Filter object. |
setShowInMenu(boolean value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | a value indicating whether project shows the filter name in the Filter drop-down list on the View tab of the Ribbon. |
setShowRelatedSummaryRows(boolean value)
public final void setShowRelatedSummaryRows(boolean value)
Sets a value indicating whether related summary rows are displayed for the filter.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | a value indicating whether related summary rows are displayed for the filter. |