JobQueryFilter class More...
Public Member Functions | |
JobQueryFilter () | |
Initializes a new instance of the JobQueryFilter 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... | |||||||||
short | CreatorFilter [get, set] | ||||||||
Gets or sets the creator filter. More... | |||||||||
short | DueDateFilterType [get, set] | ||||||||
Gets or sets the type of the due date. 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 FinishTimeFrom range criteria for the selection of the jobs. More... | |||||||||
DateTime | FinishTimeTo [get, set] | ||||||||
Gets or sets the end time for the FinishTimeTo range criteria for the selection of the jobs. More... | |||||||||
short | FinishTimeType [get, set] | ||||||||
Gets or sets the type of the finish time. More... | |||||||||
bool | GetQueryResultCount [get, set] | ||||||||
Gets or sets a value indicating whether to get the query result count. 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... | |||||||||
short | JobOwnerFilter [get, set] | ||||||||
Gets or sets the job owner filter. More... | |||||||||
int | JobPriority [get, set] | ||||||||
Gets or sets the priority of the job. More... | |||||||||
short | JobSla [get, set] | ||||||||
Gets or sets the job Sla. More... | |||||||||
string | JobState [get, set] | ||||||||
Gets or sets the state name of the job. 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.
| |||||||||
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 | ReturnStatePercentage [get, set] | ||||||||
Gets or sets a value indicating whether [return state percentage]. 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... | |||||||||
short | StartTimeType [get, set] | ||||||||
Gets or sets the start type of the time. More... | |||||||||
string | SubJobId [get, set] | ||||||||
Gets or sets the sub job details. More... | |||||||||
string | SuspendReason [get, set] | ||||||||
Gets or sets the suspend reason. More... | |||||||||
bool | UseJobPriority [get, set] | ||||||||
Gets or sets a value indicating whether the JobPriority parameter should be used. More... | |||||||||
bool | UseJobSla [get, set] | ||||||||
Gets or sets a value indicating whether ti use job Sla. 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... | |||||||||
VariableValue2Collection | Variables [get, set] | ||||||||
Gets or sets the variables. More... | |||||||||
WorkQueueDefinitionIdentity | WorkQueueDefinition [get, set] | ||||||||
Gets or sets the work queue definition details. More... | |||||||||
JobQueryFilter class
JobQueryFilter | ( | ) |
Initializes a new instance of the JobQueryFilter class.
|
getsetinherited |
Gets or sets the case details.
|
getsetinherited |
Gets or sets the unique identifier of the category to which the map on which the job was created belongs to.
|
getsetinherited |
Gets or sets the unique identifier for the creator of the Job. This parameter can also be used as criteria.
|
getset |
Gets or sets the creator filter.
|
getset |
Gets or sets the type of the due date.
|
getsetinherited |
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.
|
getsetinherited |
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.
|
getsetinherited |
Gets or sets the object containing field filter configuration.
|
getsetinherited |
Gets or sets the start time for the FinishTimeFrom range criteria for the selection of the jobs.
|
getsetinherited |
Gets or sets the end time for the FinishTimeTo range criteria for the selection of the jobs.
|
getset |
Gets or sets the type of the finish time.
|
getset |
Gets or sets a value indicating whether to get the query result count.
|
getsetinherited |
Gets or sets a value indicating whether this instance is worker resource.
|
getsetinherited |
Gets or sets the job details.
|
getsetinherited |
Gets or sets the job id collection criteria for the selection of the jobs.
|
getsetinherited |
Gets or sets the owner id of the job.
|
getset |
Gets or sets the job owner filter.
|
getsetinherited |
Gets or sets the priority of the job.
|
getsetinherited |
Gets or sets the job Sla.
|
getsetinherited |
Gets or sets the state name of the job.
|
getsetinherited |
Gets or sets the job status filter.
Enumeration | Description |
---|---|
0 | Job Criteria Active |
1 | Job Criteria All Live And Finished |
2 | Job Criteria All Finished |
3 | Job Criteria All Live |
4 | Job Criteria Completed |
5 | Job Criteria Ready For Evaluation |
6 | Job Criteria Pending Completion |
7 | Job Criteria Suspended |
8 | Job Criteria Terminated |
9 | Job Criteria On Hold |
10 | Job Criteria Awaiting Completion |
11 | Job Criteria Awaiting Case Completion |
12 | Job Criteria Terminated Awaiting Completion |
13 | Job Criteria Terminated Awaiting Case Completion |
|
getsetinherited |
Gets or sets the type of the job to search for.
Enumeration | Description |
---|---|
0 | Normal Job |
1 | Case Instance |
2 | Associated Job (Job in Case) |
|
getsetinherited |
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.
|
getsetinherited |
Gets or sets the number of jobs to be returned in the list.
|
getsetinherited |
Gets or sets a value indicating whether to return only non archived jobs.
|
getsetinherited |
Gets or sets the unique identifier of the server on which the Job was created.
|
getsetinherited |
Gets or sets the unique identifier for the Business Process. This can be used as criteria if required.
|
getsetinherited |
Gets or sets a value indicating whether to return advanced job details or not.
|
getsetinherited |
Gets or sets a value indicating whether to return due date or not.
|
getsetinherited |
Gets or sets a value indicating whether to return extra sla data or not.
|
getsetinherited |
Gets or sets a value indicating whether to return null for finished time or not.
|
getsetinherited |
Gets or sets a value indicating whether to return owner details or not.
|
getsetinherited |
Gets or sets a value indicating whether to return priority or not.
|
getsetinherited |
Gets or sets a value indicating whether to return score details or not.
|
getset |
Gets or sets a value indicating whether [return state percentage].
true
if [return state percentage]; otherwise, false
.
|
getsetinherited |
Gets or sets a value indicating whether to return total job count or not.
|
getsetinherited |
Gets or sets the score filter.
|
getsetinherited |
Gets or sets a value indicating whether the search should be performed on the sub categories.
|
getsetinherited |
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.
|
getsetinherited |
Gets or sets the start time for the StartTimeFrom date range criteria for the selection of the jobs.
|
getsetinherited |
Gets or sets the end time for the StartTimeTo date range criteria for the selection of the jobs.
|
getset |
Gets or sets the start type of the time.
|
getsetinherited |
Gets or sets the sub job details.
|
getsetinherited |
Gets or sets the suspend reason.
The suspend reason.
|
getsetinherited |
Gets or sets a value indicating whether the JobPriority parameter should be used.
|
getsetinherited |
Gets or sets a value indicating whether ti use job Sla.
|
getsetinherited |
Gets or sets a value indicating whether the JobType parameter is used.
|
getsetinherited |
Gets or sets a value indicating whether to use score filter or not.
|
getsetinherited |
Gets or sets the variables.
|
getsetinherited |
Gets or sets the work queue definition details.