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

Represents the search criteria to filter the activities. More...

Public Member Functions

 JobActivityFilter ()
 Initializes a new instance of the JobActivityFilter 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...
 
string EndDueDateTimeExpression [get, set]
 Gets or sets the name of the End DueDateTime Expression. More...
 
JobIdentity Job [get, set]
 Gets or sets the job. 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...
 
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 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...
 
string StartDueDateTimeExpression [get, set]
 Gets or sets the name of the Start DueDateTime Expression. More...
 
DateTime StartPendingTime [get, set]
 Gets or sets the start pending time. 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 criteria to filter the activities.

Constructor & Destructor Documentation

Initializes a new instance of the JobActivityFilter class.

Property Documentation

string ActivityName
getset

Gets or sets the name of the activity.

short ActivitySlaStatus
getset

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

int ActivityTypeFilters
getset

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
getset

Gets or sets the the activities for a specified case.

bool CaseActivitiesOnly
getset

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

Gets or sets the category.

short DueDateType
getset

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

The type of the due date.

string EndDueDateTimeExpression
getset

Gets or sets the name of the End DueDateTime Expression.

JobIdentity Job
getset

Gets or sets the job.

short JobSlaStatus
getset

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

string JobState
getset

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.
int MaxActivitiesCount
getset

Gets or sets maximum number of activities.

Gets or sets the meta data filter configuration.

short MFPFilterCriteria
getset

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 PageDirection
getset

Gets or sets the page direction of the next page.

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

Gets or sets the priority of activity.

short PriorityType
getset

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

The type of the priority.

ProcessIdentity Process
getset

Gets or sets the process to retrieve the activities.

ResourceIdentity Resource
getset

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
getset

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

Gets or sets the score filter.

ActivitySortOptionsCollection SortOptions
getset

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
getset

Gets or sets the start due date time.

Remarks
If StartDueDateTime is null, then the filter is not considered.
string StartDueDateTimeExpression
getset

Gets or sets the name of the Start DueDateTime Expression.

DateTime StartPendingTime
getset

Gets or sets the start pending time.

Remarks
If StartPendingTime is null, then the filter is not considered.
bool UseActivitySlaStatus
getset

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

bool UseCombinedWorkQueue
getset

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

bool UseJobSlaStatus
getset

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

short UsePrioritySetting
getset

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.