Class JobFilter

Filter specified when querying for jobs.

Inheritance

System.Object

JobFilter

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 JobFilter

Constructors

JobFilter(Int32)

Filter used when querying for jobs.

Declaration

public JobFilter(int processId_ = 1)

Parameters

Type	Name	Description
System.Int32	processId_	Identifies the target JTProcess

Properties

JobStatus

Limit the set of returned jobs to either Active or Complete.

Declaration

public Job.JobStatus_Enum? JobStatus { get; set; }

Property Value

Type	Description
System.Nullable<Job.JobStatus_Enum>

ProcessId

Identifies the target JTProcess.

Declaration

public int ProcessId { get; set; }

Property Value

Type	Description
System.Int32

ViewId

Sets a view filter.

Declaration

public int? ViewId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Methods

AddJobCustomFieldFilter(Int32, ICustomFieldFilter)

Adds a filter for a job custom field. (May be one of ListOfValuesFilter, TextFilter, NumberFilter or DateFilter)

Declaration

public void AddJobCustomFieldFilter(int customFieldId_, ICustomFieldFilter filter_)

Parameters

Type	Name	Description
System.Int32	customFieldId_	Identifies the job custom field to which the filter applies.
ICustomFieldFilter	filter_	Describes the filter. (May be one of ListOfValuesFilter, TextFilter, NumberFilter or DateFilter)

AddListOfValuesFilter(JobFilter.JobListOfValuesFilterFields_Enum, ListOfValuesFilter)

Adds a list of values filter for one of the built-in fields.

Declaration

public void AddListOfValuesFilter(JobFilter.JobListOfValuesFilterFields_Enum field_, ListOfValuesFilter listOfValuesFilter_)

Parameters

Type	Name	Description
JobFilter.JobListOfValuesFilterFields_Enum	field_	The field being filtered.
ListOfValuesFilter	listOfValuesFilter_	The filter being applied.

AddTextFilter(JobFilter.JobTextFilterFields_Enum, TextFilter)

Adds a text filter for one of the built-in fields.

Declaration

public void AddTextFilter(JobFilter.JobTextFilterFields_Enum field_, TextFilter textFilter_)

Parameters

Type	Name	Description
JobFilter.JobTextFilterFields_Enum	field_	The field being filtered.
TextFilter	textFilter_	The filter being applied.