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

Represents the filter criteria to take the next activity. More...

Public Member Functions

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

Properties

string ActivityName [get, set]
 Gets or sets the name of the activities. More...
 
short ActivitySlaStatus [get, set]
 Gets or sets the status of the activity using sla notation. More...
 
short ActivityTypeFilters [get, set]
 Gets or sets the type of activities. More...
 
short JobSlaStatus [get, set]
 Gets or sets the status of the job using sla notation. More...
 
string JobState [get, set]
 Gets or sets job state. 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 to be returned. More...
 
MetaDataFilter MetadataFilter [get, set]
 Gets or sets the meta data filter configuration. More...
 
short Priority [get, set]
 Gets or sets the priority of activities to be retieved. More...
 
DateTime StartDueDate [get, set]
 Gets or sets the start due date time. 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 filter workqueue with respect to activity sla status. More...
 
bool UseCombinedWorkQueue [get, set]
 Gets or sets a value indicating whether to use combined workqueue or individual. More...
 
bool UseJobSlaStatus [get, set]
 Gets or sets a value indicating whether or not the workqueue should be filtered with respect to job sla status. More...
 
short UsePriority [get, set]
 Gets or sets the whether priority to be included in the search criteria. More...
 
bool UseWorkAllocationRules [get, set]
 Gets or sets a value indicating whether to use work allocation rules or not. More...
 
WorkQueueDefinitionIdentity WorkQueueDefinition [get, set]
 Gets or sets the workqueue definition to include in search criteria. More...
 

Description

Represents the filter criteria to take the next activity.

Constructor & Destructor Documentation

Initializes a new instance of the TakeNextActivityFilter class.

Property Documentation

string ActivityName
getset

Gets or sets the name of the activities.

short ActivitySlaStatus
getset

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

short ActivityTypeFilters
getset

Gets or sets the type of activities.

Remarks
Enumeratation for activity type is as follows
EnumerationDescription
1Manual Ordinary
4Manual Script
8Manual Create New Job
32Auto Script
64Auto Transactional
128Auto Create New Job
256Manual Adhoc
512Manual Mobile
1024Alert Task
short JobSlaStatus
getset

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

string JobState
getset

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

int MaxActivitiesCount
getset

Gets or sets maximum number of activities to be returned.

MetaDataFilter MetadataFilter
getset

Gets or sets the meta data filter configuration.

short Priority
getset

Gets or sets the priority of activities to be retieved.

DateTime StartDueDate
getset

Gets or sets the start due date time.

DateTime StartPendingTime
getset

Gets or sets the start pending time.

bool UseActivitySlaStatus
getset

Gets or sets a value indicating whether to filter workqueue with respect to activity sla status.

bool UseCombinedWorkQueue
getset

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

bool UseJobSlaStatus
getset

Gets or sets a value indicating whether or not the workqueue should be filtered with respect to job sla status.

short UsePriority
getset

Gets or sets the whether priority to be included in the search criteria.

Remarks
EnumerationDescription
0NotUsingPriority - The work queue will be returned without it ordered by priority so all activities will be returned ordered by due date instead.
1UsingPriority - The work queue will be returned in order of priority.
2UsingStartPriority - The work queue will be returned in order of priority (1 being highest, 10 being lowest), from the priority specified in the PrioritiesToRetrieve parameter.
3UsingSpecificPriority - The work queue will only return activities of the specific priority provided in the PrioritiesToRetrieve parameter.
bool UseWorkAllocationRules
getset

Gets or sets a value indicating whether to use work allocation rules or not.

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