All Classes Namespaces Functions Properties Pages
Public Member Functions | Properties | List of all members
JobFilter Class Reference

Specifies the criteria to retrieve the job information. More...

Public Member Functions

 JobFilter ()
 Initializes a new instance of the JobFilter class. More...
 

Properties

CaseIdentity Case [get, set]
 Gets or sets the case details. More...
 
CategoryIdentity Category [get, set]
 Gets or sets the unique identifier of the category to which the map on which the job was created belongs to. More...
 
ResourceIdentity Creator [get, set]
 Gets or sets the unique identifier for the creator of the Job. This parameter can also be used as criteria. More...
 
DateTime DueDateFrom [get, set]
 Gets or sets the DueDateFrom. Note: In case, only DueDateFrom is only specified and DueDateTo is not specified, jobs are returned where the due date is less than or equal to DueDateFrom but if both DueDateFrom and DueDateTo are specified, then the jobs are returned based on the condition where the due date is greater than or equal to DueDateFrom and less than or equal to DueDateTo. More...
 
DateTime DueDateTo [get, set]
 Gets or sets the date that the job is due. Note: In case, only DueDateFrom is only specified and DueDateTo is not specified, jobs are returned where the due date is less than or equal to DueDateFrom but if both DueDateFrom and DueDateTo are specified, then the jobs are returned based on the condition where the due date is greater than or equal to DueDateFrom and less than or equal to DueDateTo. More...
 
FieldFilter FieldFilter [get, set]
 Gets or sets the object containing field filter configuration. More...
 
DateTime FinishTimeFrom [get, set]
 Gets or sets the start time for the FinishTime range criteria for the selection of the jobs. More...
 
DateTime FinishTimeTo [get, set]
 Gets or sets the end time for the FinishTime range criteria for the selection of the jobs. More...
 
bool IsWorkerResource [get, set]
 Gets or sets a value indicating whether this instance is worker resource. More...
 
JobIdentity Job [get, set]
 Gets or sets the job details. More...
 
JobIdentityCollection JobIdsFilter [get, set]
 Gets or sets the job id collection criteria for the selection of the jobs. More...
 
ResourceIdentity JobOwner [get, set]
 Gets or sets the owner id of the job. More...
 
int JobPriority [get, set]
 Gets or sets the priority of the job. More...
 
string JobState [get, set]
 Gets or sets the state name of the job. More...
 
short JobStatus [get, set]
 Gets or sets the status of the Job.

EnumerationDescription
0Active
1Completed
2Terminated
3Suspended
4Pending Completion
6Ready For Evaluation
7On Hold
8Awaiting Completion
9Awaiting Case Completion
10Awaiting Completion Terminated
11Awaiting Case Completion Terminated
More...
 
short JobStatusFilter [get, set]
 Gets or sets the job status filter. More...
 
short JobType [get, set]
 Gets or sets the type of the job to search for.

EnumerationDescription
0Normal Job
1Case Instance
2Associated Job (Job in Case)
More...
 
bool JobViewAccess [get, set]
 Gets or sets a value indicating whether job view access parameter should be used. This property is obsolete. The System setting, "Restrict Job Access" now determines if the job view access should be applied. More...
 
int MaxNumberToRetrieve [get, set]
 Gets or sets the number of jobs to be returned in the list. More...
 
bool OnlyReturnNonArchivedJobs [get, set]
 Gets or sets a value indicating whether to return only non archived jobs. More...
 
ServerIdentity OriginServer [get, set]
 Gets or sets the unique identifier of the server on which the Job was created. More...
 
ProcessIdentity Process [get, set]
 Gets or sets the unique identifier for the Business Process. This can be used as criteria if required. More...
 
bool ReturnAdvancedJobDetails [get, set]
 Gets or sets a value indicating whether to return advanced job details or not. More...
 
bool ReturnDueDate [get, set]
 Gets or sets a value indicating whether to return due date or not. More...
 
bool ReturnExtraSlaData [get, set]
 Gets or sets a value indicating whether to return extra sla data or not. More...
 
bool ReturnNullForFinishedTime [get, set]
 Gets or sets a value indicating whether to return null for finished time or not. More...
 
bool ReturnOwnerDetails [get, set]
 Gets or sets a value indicating whether to return owner details or not. More...
 
bool ReturnPriority [get, set]
 Gets or sets a value indicating whether to return priority or not. More...
 
bool ReturnScore [get, set]
 Gets or sets a value indicating whether to return score details or not. More...
 
bool ReturnTotalJobCount [get, set]
 Gets or sets a value indicating whether to return total job count or not. More...
 
ScoreFilter ScoreFilter [get, set]
 Gets or sets the score filter. More...
 
bool SearchInSubcategories [get, set]
 Gets or sets a value indicating whether the search should be performed on the sub categories. More...
 
JobSortOptionsCollection SortOptions [get, set]
 Gets or sets the sort options which holds the sorting details of the jobs Queries. When ServerSettings property “Enable Job List Custom Sorting” is turned on, based on this SortOptions info sorting will be performed. If SortOptions is null, sorting will be performed as per default sort order. More...
 
DateTime StartTimeFrom [get, set]
 Gets or sets the start time for the StartTimeFrom date range criteria for the selection of the jobs. More...
 
DateTime StartTimeTo [get, set]
 Gets or sets the end time for the StartTimeTo date range criteria for the selection of the jobs. More...
 
string SubJobId [get, set]
 Gets or sets the sub job details. More...
 
bool UseJobPriority [get, set]
 Gets or sets a value indicating whether the JobPriority parameter should be used. More...
 
bool UseJobStatus [get, set]
 Gets or sets a value indicating whether [use job status] parameter should be used. More...
 
bool UseJobType [get, set]
 Gets or sets a value indicating whether the JobType parameter is used. More...
 
bool UseScoreFilter [get, set]
 Gets or sets a value indicating whether to use score filter or not. More...
 
WorkQueueDefinitionIdentity WorkQueueDefinition [get, set]
 Gets or sets the work queue definition details. More...
 

Description

Specifies the criteria to retrieve the job information.

Constructor & Destructor Documentation

JobFilter ( )

Initializes a new instance of the JobFilter class.

Property Documentation

CaseIdentity Case
getset

Gets or sets the case details.

Gets or sets the unique identifier of the category to which the map on which the job was created belongs to.

ResourceIdentity Creator
getset

Gets or sets the unique identifier for the creator of the Job. This parameter can also be used as criteria.

DateTime DueDateFrom
getset

Gets or sets the DueDateFrom. Note: In case, only DueDateFrom is only specified and DueDateTo is not specified, jobs are returned where the due date is less than or equal to DueDateFrom but if both DueDateFrom and DueDateTo are specified, then the jobs are returned based on the condition where the due date is greater than or equal to DueDateFrom and less than or equal to DueDateTo.

DateTime DueDateTo
getset

Gets or sets the date that the job is due. Note: In case, only DueDateFrom is only specified and DueDateTo is not specified, jobs are returned where the due date is less than or equal to DueDateFrom but if both DueDateFrom and DueDateTo are specified, then the jobs are returned based on the condition where the due date is greater than or equal to DueDateFrom and less than or equal to DueDateTo.

Gets or sets the object containing field filter configuration.

DateTime FinishTimeFrom
getset

Gets or sets the start time for the FinishTime range criteria for the selection of the jobs.

DateTime FinishTimeTo
getset

Gets or sets the end time for the FinishTime range criteria for the selection of the jobs.

bool IsWorkerResource
getset

Gets or sets a value indicating whether this instance is worker resource.

JobIdentity Job
getset

Gets or sets the job details.

JobIdentityCollection JobIdsFilter
getset

Gets or sets the job id collection criteria for the selection of the jobs.

ResourceIdentity JobOwner
getset

Gets or sets the owner id of the job.

int JobPriority
getset

Gets or sets the priority of the job.

string JobState
getset

Gets or sets the state name of the job.

short JobStatus
getset

Gets or sets the status of the Job.

EnumerationDescription
0Active
1Completed
2Terminated
3Suspended
4Pending Completion
6Ready For Evaluation
7On Hold
8Awaiting Completion
9Awaiting Case Completion
10Awaiting Completion Terminated
11Awaiting Case Completion Terminated

short JobStatusFilter
getset

Gets or sets the job status filter.

EnumerationDescription
0Job Criteria Active
1Job Criteria All Live And Finished
2Job Criteria All Finished
3Job Criteria All Live
4Job Criteria Completed
5Job Criteria Ready For Evaluation
6Job Criteria Pending Completion
7Job Criteria Suspended
8Job Criteria Terminated
9Job Criteria On Hold
10Job Criteria Awaiting Completion
11Job Criteria Awaiting Case Completion
12Job Criteria Terminated Awaiting Completion
13Job Criteria Terminated Awaiting Case Completion
short JobType
getset

Gets or sets the type of the job to search for.

EnumerationDescription
0Normal Job
1Case Instance
2Associated Job (Job in Case)

bool JobViewAccess
getset

Gets or sets a value indicating whether job view access parameter should be used. This property is obsolete. The System setting, "Restrict Job Access" now determines if the job view access should be applied.

int MaxNumberToRetrieve
getset

Gets or sets the number of jobs to be returned in the list.

bool OnlyReturnNonArchivedJobs
getset

Gets or sets a value indicating whether to return only non archived jobs.

ServerIdentity OriginServer
getset

Gets or sets the unique identifier of the server on which the Job was created.

ProcessIdentity Process
getset

Gets or sets the unique identifier for the Business Process. This can be used as criteria if required.

bool ReturnAdvancedJobDetails
getset

Gets or sets a value indicating whether to return advanced job details or not.

bool ReturnDueDate
getset

Gets or sets a value indicating whether to return due date or not.

bool ReturnExtraSlaData
getset

Gets or sets a value indicating whether to return extra sla data or not.

bool ReturnNullForFinishedTime
getset

Gets or sets a value indicating whether to return null for finished time or not.

bool ReturnOwnerDetails
getset

Gets or sets a value indicating whether to return owner details or not.

bool ReturnPriority
getset

Gets or sets a value indicating whether to return priority or not.

bool ReturnScore
getset

Gets or sets a value indicating whether to return score details or not.

bool ReturnTotalJobCount
getset

Gets or sets a value indicating whether to return total job count or not.

Gets or sets the score filter.

bool SearchInSubcategories
getset

Gets or sets a value indicating whether the search should be performed on the sub categories.

JobSortOptionsCollection SortOptions
getset

Gets or sets the sort options which holds the sorting details of the jobs Queries. When ServerSettings property “Enable Job List Custom Sorting” is turned on, based on this SortOptions info sorting will be performed. If SortOptions is null, sorting will be performed as per default sort order.

DateTime StartTimeFrom
getset

Gets or sets the start time for the StartTimeFrom date range criteria for the selection of the jobs.

DateTime StartTimeTo
getset

Gets or sets the end time for the StartTimeTo date range criteria for the selection of the jobs.

string SubJobId
getset

Gets or sets the sub job details.

bool UseJobPriority
getset

Gets or sets a value indicating whether the JobPriority parameter should be used.

bool UseJobStatus
getset

Gets or sets a value indicating whether [use job status] parameter should be used.

bool UseJobType
getset

Gets or sets a value indicating whether the JobType parameter is used.

bool UseScoreFilter
getset

Gets or sets a value indicating whether to use score filter or not.

Gets or sets the work queue definition details.