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

Represents the search filter criteria for activities such as activity status, job ids, and end due date. More...

Public Member Functions

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

Properties

string ActivityName [get, set]
 Gets or sets the name of the activity. More...
 
short ActivitySlaStatus [get, set]
 Gets or sets the status of the activity using sla notation. More...
 
int ActivityTypeFilters [get, set]
 Gets or sets the type of activity. More...
 
CaseIdentity Case [get, set]
 Gets or sets the the activities for a specified case. More...
 
bool CaseActivitiesOnly [get, set]
 Gets or sets a value indicating whether to retrieve activities based on the case. More...
 
CategoryIdentity Category [get, set]
 Gets or sets the category. More...
 
short DueDateType [get, set]
 Gets or sets the type of the due date. Valid values are 0 (ACtivity) and 1 (Job). More...
 
DateTime EndDueDateTime [get, set]
 Gets or sets the end due date time. More...
 
JobIdentityCollection JobIdsFilter [get, set]
 Gets or sets the job ids filter. More...
 
short JobSlaStatus [get, set]
 Gets or sets the status of the job using sla notation. More...
 
string JobState [get, set]
 Gets or sets the state of the job. States can be used to monitor the status or percentage complete of a particular job. More...
 
ResourceIdentity LoanResource [get, set]
 Gets or sets the loan resource. More...
 
int MaxActivitiesCount [get, set]
 Gets or sets maximum number of activities. More...
 
MetaDataFilter MetaDataFilter [get, set]
 Gets or sets the meta data filter configuration. More...
 
short MFPFilterCriteria [get, set]
 Gets or sets the value for retrieving the activities based on MFP Ready settings. Valid values are 0 (Retries MFPFriendly and non MFP activities) and 1 (Retries MFPFriendly and MFPOnly activities). More...
 
short NodeId [get, set]
 Gets or sets the node id. More...
 
short PageDirection [get, set]
 Gets or sets the page direction of the next page. More...
 
short Priority [get, set]
 Gets or sets the priority of activity. More...
 
short PriorityType [get, set]
 Gets or sets the type of the priority. Valid values are 0 (ACtivity) and 1 (Job). More...
 
ProcessIdentity Process [get, set]
 Gets or sets the process to retrieve the activities. More...
 
ResourceIdentity Resource [get, set]
 Gets or sets the details of the resource id. More...
 
bool ReturnJobIds [get, set]
 Gets or sets a value indicating whether to set return jobids. More...
 
ScoreFilter ScoreFilter [get, set]
 Gets or sets the score filter. More...
 
ActivitySortOptionsCollection SortOptions [get, set]
 Gets or sets the sort options which holds the sorting details of the workqueue/ System Queries. When ServerSettings property “Enable Workqueue 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 StartDueDateTime [get, set]
 Gets or sets the start due date time. More...
 
DateTime StartPendingTime [get, set]
 Gets or sets the start pending time. More...
 
short StatusFilter [get, set]
 Gets or sets the activity status filter to search on. More...
 
string SuspendReason [get, set]
 Gets or sets the suspend reason. More...
 
bool UseActivitySlaStatus [get, set]
 Gets or sets a value indicating whether to use activity sla status. More...
 
bool UseCombinedWorkQueue [get, set]
 Gets or sets a value indicating whether to use a combined workqueue. More...
 
bool UseJobSlaStatus [get, set]
 Gets or sets a value indicating whether to use job sla status. More...
 
short UsePrioritySetting [get, set]
 Gets or sets the whether to use priority in search criteria. More...
 
WorkQueueDefinitionIdentity WorkQueueDefinition [get, set]
 Gets or sets the workqueue definition to include in search criteria. More...
 

Description

Represents the search filter criteria for activities such as activity status, job ids, and end due date.

Constructor & Destructor Documentation

Initializes a new instance of the JobActivityFilter3 class.

Property Documentation

string ActivityName
getsetinherited

Gets or sets the name of the activity.

short ActivitySlaStatus
getsetinherited

Gets or sets the status of the activity using sla notation.

int ActivityTypeFilters
getsetinherited

Gets or sets the type of activity.

Remarks
EnumerationDescription
1Manual Ordinary
4Manual Script
8Manual Create New Job
32Auto Script
64Auto Transactional
128Auto Create New Job
256Manual Adhoc
512Manual Mobile
1024Alert Task
CaseIdentity Case
getsetinherited

Gets or sets the the activities for a specified case.

bool CaseActivitiesOnly
getsetinherited

Gets or sets a value indicating whether to retrieve activities based on the case.

CategoryIdentity Category
getsetinherited

Gets or sets the category.

short DueDateType
getsetinherited

Gets or sets the type of the due date. Valid values are 0 (ACtivity) and 1 (Job).

The type of the due date.

DateTime EndDueDateTime
getsetinherited

Gets or sets the end due date time.

JobIdentityCollection JobIdsFilter
getsetinherited

Gets or sets the job ids filter.

Remarks
The details of the job ids to be retrieved should be included in the collection.
short JobSlaStatus
getsetinherited

Gets or sets the status of the job using sla notation.

string JobState
getsetinherited

Gets or sets the state of the job. States can be used to monitor the status or percentage complete of a particular job.

Remarks
If JobState is null or empty, this filter criteria is not considered.
ResourceIdentity LoanResource
getset

Gets or sets the loan resource.

int MaxActivitiesCount
getsetinherited

Gets or sets maximum number of activities.

MetaDataFilter MetaDataFilter
getsetinherited

Gets or sets the meta data filter configuration.

short MFPFilterCriteria
getsetinherited

Gets or sets the value for retrieving the activities based on MFP Ready settings. Valid values are 0 (Retries MFPFriendly and non MFP activities) and 1 (Retries MFPFriendly and MFPOnly activities).

short NodeId
getset

Gets or sets the node id.

short PageDirection
getsetinherited

Gets or sets the page direction of the next page.

Remarks
0 - retrieve next page 1 - retrieve previous page
short Priority
getsetinherited

Gets or sets the priority of activity.

short PriorityType
getsetinherited

Gets or sets the type of the priority. Valid values are 0 (ACtivity) and 1 (Job).

The type of the priority.

ProcessIdentity Process
getsetinherited

Gets or sets the process to retrieve the activities.

ResourceIdentity Resource
getsetinherited

Gets or sets the details of the resource id.

Remarks
This is required only if it is a group that the workqueue is being retrieved for and the the caller must be a member of the specified group.
bool ReturnJobIds
getsetinherited

Gets or sets a value indicating whether to set return jobids.

ScoreFilter ScoreFilter
getsetinherited

Gets or sets the score filter.

ActivitySortOptionsCollection SortOptions
getsetinherited

Gets or sets the sort options which holds the sorting details of the workqueue/ System Queries. When ServerSettings property “Enable Workqueue 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 StartDueDateTime
getsetinherited

Gets or sets the start due date time.

Remarks
If StartDueDateTime is null, then the filter is not considered.
DateTime StartPendingTime
getsetinherited

Gets or sets the start pending time.

Remarks
If StartPendingTime is null, then the filter is not considered.
short StatusFilter
getsetinherited

Gets or sets the activity status filter to search on.

EnumerationDescription
0Pending Activity
1Active Activity
2Offered Activity
3Suspended Activity
4Activity Locked
5Active Activity No Evaluation
128All Live Activities
string SuspendReason
getset

Gets or sets the suspend reason.

The suspend reason.

bool UseActivitySlaStatus
getsetinherited

Gets or sets a value indicating whether to use activity sla status.

bool UseCombinedWorkQueue
getsetinherited

Gets or sets a value indicating whether to use a combined workqueue.

bool UseJobSlaStatus
getsetinherited

Gets or sets a value indicating whether to use job sla status.

short UsePrioritySetting
getsetinherited

Gets or sets the whether to use priority in search criteria.

Remarks
EnumerationDescription
0Not Using Priority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead.
1Using Priority - The work queue will be returned in order of priority.
2Using Start Priority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), from the priority specified in the PrioritiesToRetrieve parameter.
3Using Specific Priority - The work queue will only return activities of the specific priority provided in the PrioritiesToRetrieve parameter.

Gets or sets the workqueue definition to include in search criteria.