Is( ) method

Determines whether the Progress.BPM.Task instance passed to it satisfies some set of filter criteria. This method is defined by the ITaskFilter interface. It is called by some overloads of the Progress.BPM.UserSession GetAvailableTasks( ) and GetAssignedTasks( ) methods to determine whether to include a given Task in the array of tasks that they return. Implementations are expected to to apply some set of criteria to the Task parameter and return YES if the Task meets the criteria or NO if it does not.

The Progress.BPM.Filter.* classes provide implementations of this method. Alternatively, you can define a class that implements the Progress.BPM.Filter.ITaskFilter interface. Each of the built-in Progress.BPM.Filter.* classes implements a simple filter with this method based on one property of the Task class. The filter compares a particular Task property, whose type is either CHARACTER or DATETIME, with a comparison value assigned to the filter class's FilterValue property of the same type.

This method is typically called by the Get*Tasks( ) methods of the Progress.BPM.UserSession class. See Progress.BPM.UserSession class for more information.

Return type:

LOGICAL

Access:

PUBLIC

Applies to:

Progress.BPM.Filter.ITaskFilter interface, Progress.BPM.Filter.TaskActivityFilter class, Progress.BPM.Filter.TaskCreatorFilter class, Progress.BPM.Filter.TaskDueDateFilter class Progress.BPM.Filter.TaskNameFilter class, Progress.BPM.Filter.TaskPerformerFilter class, Progress.BPM.Filter.TaskPriorityFilter class, Progress.BPM.Filter.TaskProcessFilter class, Progress.BPM.Filter.TaskProcessTemplateFilter class Progress.BPM.Filter.TaskTimeStartedFilter class

 

Syntax 

Is( INPUT theTask AS Progress.BPM.Task )

theTask

A Progress.BPM.Task object that the method will test.

The method returns TRUE if the Progress.BPM.Task property matches or has a specified relationship with the FilterValue property of a built-in filter class, or satisfies the filter criteria implemented for an ABL user-defined filter class; otherwise, the method returns FALSE.

Implementations by the built-in Progress.BPM.Filter classes for CHARACTER Task properties

The method returns a LOGICAL value indicating whether the Task CHARACTER property matches the FilterValue property value. The comparison is done as if it were being done by the ABL MATCHES operator. The FilterValue property value can, therefore, include a period (.) to match any character and an asterisk (*) to match any group of characters including a null group, with a tilde (~) serving as an escape character for any character or group of characters. The comparison is case insensitive.

For more information about the FilterValue property, see FilterValue property (CHARACTER) and FilterValue property (DATETIME).

Implementations by the built-in Progress.BPM.Filter classes for DATETIME Task properties

The method returns a LOGICAL value indicating whether the Task DATETIME property has the correct relationship to the FilterValue property of the applicable built-in filter class. The relationship is specified by a Relationship argument that is passed to the filter-class constructor.

The method raises a BPM error if the Relationship argument to the filter-class constructor does not resolve to an acceptable value.

For more information about the FilterValue property, see FilterValue property (CHARACTER) and FilterValue property (DATETIME).

Implementations by user-defined filter classes

You can provide an implementation of the method in a user-defined ABL filter class that implements the Progress.BPM.Filter.ITaskFilter interface. This method then returns a LOGICAL value indicating if the input Task object meets the filter criteria specified by your implementation, which might include comparisons to one or more Task property values.

When you are implementing the interface, the only required class member is the Is( ) method. It is possible, however, that you will add a property for storing a value. The Is( ) method might then compare the value of that property to some property of its Task parameter as part of method implementation and return a LOGICAL value indicating whether the Progress.BPM.Task object parameter meets some set of criteria, as defined by the implementation of this method.