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

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.

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 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...
 
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...
 

Description

JobQueryFilter class

Constructor & Destructor Documentation

Initializes a new instance of the JobQueryFilter class.

Property Documentation

CaseIdentity Case
getsetinherited

Gets or sets the case details.

CategoryIdentity Category
getsetinherited

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

ResourceIdentity Creator
getsetinherited

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

short CreatorFilter
getset

Gets or sets the creator filter.

short DueDateFilterType
getset

Gets or sets the type of the due date.

DateTime DueDateFrom
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.

DateTime 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.

FieldFilter FieldFilter
getsetinherited

Gets or sets the object containing field filter configuration.

DateTime FinishTimeFrom
getsetinherited

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

DateTime FinishTimeTo
getsetinherited

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

short FinishTimeType
getset

Gets or sets the type of the finish time.

bool GetQueryResultCount
getset

Gets or sets a value indicating whether to get the query result count.

bool IsWorkerResource
getsetinherited

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

JobIdentity Job
getsetinherited

Gets or sets the job details.

JobIdentityCollection JobIdsFilter
getsetinherited

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

ResourceIdentity JobOwner
getsetinherited

Gets or sets the owner id of the job.

short JobOwnerFilter
getset

Gets or sets the job owner filter.

int JobPriority
getsetinherited

Gets or sets the priority of the job.

short JobSla
getsetinherited

Gets or sets the job Sla.

string JobState
getsetinherited

Gets or sets the state name of the job.

short JobStatusFilter
getsetinherited

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
getsetinherited

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

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

bool JobViewAccess
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.

int MaxNumberToRetrieve
getsetinherited

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

bool OnlyReturnNonArchivedJobs
getsetinherited

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

ServerIdentity OriginServer
getsetinherited

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

ProcessIdentity Process
getsetinherited

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

bool ReturnAdvancedJobDetails
getsetinherited

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

bool ReturnDueDate
getsetinherited

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

bool ReturnExtraSlaData
getsetinherited

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

bool ReturnNullForFinishedTime
getsetinherited

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

bool ReturnOwnerDetails
getsetinherited

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

bool ReturnPriority
getsetinherited

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

bool ReturnScore
getsetinherited

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

bool ReturnStatePercentage
getset

Gets or sets a value indicating whether [return state percentage].

true if [return state percentage]; otherwise, false.

bool ReturnTotalJobCount
getsetinherited

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

ScoreFilter ScoreFilter
getsetinherited

Gets or sets the score filter.

bool SearchInSubcategories
getsetinherited

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

JobSortOptionsCollection SortOptions
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.

DateTime StartTimeFrom
getsetinherited

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

DateTime StartTimeTo
getsetinherited

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

short StartTimeType
getset

Gets or sets the start type of the time.

string SubJobId
getsetinherited

Gets or sets the sub job details.

bool UseJobPriority
getsetinherited

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

bool UseJobSla
getsetinherited

Gets or sets a value indicating whether ti use job Sla.

bool UseJobType
getsetinherited

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

bool UseScoreFilter
getsetinherited

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

VariableValue2Collection Variables
getsetinherited

Gets or sets the variables.

Gets or sets the work queue definition details.