Class NumberFilter

Filter for numeric fields.

Inheritance
System.Object
Filter
NumberFilter
Implements
System.ICloneable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Moraware.JobTrackerAPI5
Assembly: JobTrackerAPI5.dll
Syntax
public class NumberFilter : Filter, ICustomFieldFilter, IFilter, ICloneable

Constructors

NumberFilter(Boolean)

Intended to allow creation of a filter for an empty number.

Declaration
public NumberFilter(bool empty_)
Parameters
Type Name Description
System.Boolean empty_

True if the filter should limit to missing numbers.

NumberFilter(Nullable<Decimal>, Nullable<Decimal>)

Creates a filter that specifies a range of values with optional upper and lower bounds.

Declaration
public NumberFilter(decimal? minValue_, decimal? maxValue_)
Parameters
Type Name Description
System.Nullable<System.Decimal> minValue_

(Optional) least value allowed.
System.Nullable<System.Decimal> maxValue_

(Optional)highest value allowed.
Remarks

If Empty=False, MaxValue=Null and MinValue=Null then using this filter in a query will result in an exception.

Properties

Empty

True if the filter should match only empty values. False if the filter should make use of the search text. When set to True, the other properties are set to null. If Empty=False, MaxValue=Null and MinValue=Null then using this filter in a query will result in an exception.

Declaration
public bool Empty { get; set; }
Property Value
Type Description
System.Boolean

FilterType

Identifies the filter type.

Declaration
public CustomFieldFilterType_Enum FilterType { get; }
Property Value
Type Description
CustomFieldFilterType_Enum

MaxValue

The maximum value allowed. When this is set to a non-null value, Empty is set to False. If Empty=False, MaxValue=Null and MinValue=Null then using this filter in a query will result in an exception.

Declaration
public decimal? MaxValue { get; set; }
Property Value
Type Description
System.Nullable<System.Decimal>

MinValue

The minimum value allowed. When this is set to a non-null value, Empty is set to False. If Empty=False, MaxValue=Null and MinValue=Null then using this filter in a query will result in an exception.

Declaration
public decimal? MinValue { get; set; }
Property Value
Type Description
System.Nullable<System.Decimal>

Methods

BuildDescription(String)

Builds a description of the filter.

Declaration
public string BuildDescription(string fieldName_)
Parameters
Type Name Description
System.String fieldName_

Name of the field to use in the description of the filter.
Returns
Type Description
System.String

A description of the filter

Clone()

Creates a copy of this filter.

Declaration
public override object Clone()
Returns
Type Description
System.Object

A copy of this filter.
Overrides

Implements

System.ICloneable