FilterCriteria

Inheritance: java.lang.Object

public class FilterCriteria

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

Constructors

Constructor	Description
FilterCriteria()

Methods

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

FilterCriteria()

public FilterCriteria()

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: java.util.List<com.aspose.tasks.FilterCriteria> - the list of child FilterCriteria rows.

getField()

public final int getField()

Gets a Field(getField()/setField(int)) to change.

Returns: int - a Field(getField()/setField(int)) to change.

getOperation()

public final int getOperation()

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

Returns: int - 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: int - 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: java.lang.Object[] - 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: boolean - whether the right-hand value of FilterCriteria is a field reference, not a constant value.

isValueAField(int index)

public final boolean isValueAField(int index)

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

Parameters:

Parameter	Type	Description
index	int	the index of the value

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

setField(int value)

public final void setField(int value)

Sets a Field(getField()/setField(int)) to change.

Parameters:

Parameter	Type	Description
value	int	a Field(getField()/setField(int)) to change.

setOperation(int value)

public final void setOperation(int value)

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

Parameters:

Parameter	Type	Description
value	int	the criterion established with FieldName, Test, and Value relates to other criteria in the filter.

setTest(int value)

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:

Parameter	Type	Description
value	int	the type of comparison made between FieldName and Value that acts as selection criteria for the filter.

setValue(int index, Object value)

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:

Parameter	Type	Description
index	int	the index of the value.
value	java.lang.Object	object value which will serve as right-hand value at the index of filter criteria.

setValue(Object value)

public final void setValue(Object value)

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

Parameters:

Parameter	Type	Description
value	java.lang.Object	object value which will serve as right-hand value of filter criteria.

setValueByField(int value)

public final void setValueByField(int value)

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

Parameters:

Parameter	Type	Description
value	int	Field which will serve as right-hand value of filter criteria.

setValueByField(int index, int value)

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:

Parameter	Type	Description
index	int	the index of the value
value	int	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.

Returns: java.lang.String - string representation of this object.