Visit Platform at http://www.platform.com

Main Page   Class Hierarchy   Compound List   Compound Members  

TaskIdFilter Class Reference

A task output filter that is defined by a set of task IDs. More...

Inheritance diagram for TaskIdFilter:

TaskOutputFilter List of all members.

Public Methods

 TaskIdFilter (void)
 Constructs a TaskIdFilter object.

virtual ~TaskIdFilter (void)
 Destructor for a TaskIdFilter object.

bool addId (const char *taskId) throw (SoamException)
 Adds the specified task ID to the filter.

bool removeId (const char *taskId) throw (SoamException)
 Removes the specified task ID from the filter.

virtual void reset () throw (SoamException)
 Resets the filter criteria.

virtual SoamBool isSatisfied () throw (SoamException)
 Tests whether the filter has been satisfied.

virtual void enableValidation (SoamBool shouldEnable) throw (SoamException)
 Enables or disables filter validation. By default, filter validation is disabled.


Detailed Description

A task output filter that is defined by a set of task IDs.

NOTE: If any of the methods of this class are called after the main(...) method exits, the client or service process may behave in an undefined manner (for example, hang or terminate abnormally).

See also:
TaskOutputFilter


Constructor & Destructor Documentation

TaskIdFilter void   
 

Constructs a TaskIdFilter object.

virtual ~TaskIdFilter void    [virtual]
 

Destructor for a TaskIdFilter object.


Member Function Documentation

bool addId const char *    taskId throw (SoamException)
 

Adds the specified task ID to the filter.

Parameters:
taskId  [IN] - The task ID of the task to add to the filter.
Returns:
True if the task ID was successfully added to the filter, false if the task ID was already in the filter.
Exceptions:
SoamException 

bool removeId const char *    taskId throw (SoamException)
 

Removes the specified task ID from the filter.

Parameters:
taskId  [IN] - The task ID of the task to remove from the filter.
Returns:
True if the task ID was successfully removed from the filter, false if the task ID was not in the filter.
Exceptions:
SoamException 

virtual void reset   throw (SoamException) [virtual]
 

Resets the filter criteria.

Exceptions:
SoamException 

Implements TaskOutputFilter.

virtual SoamBool isSatisfied   throw (SoamException) [virtual]
 

Tests whether the filter has been satisfied.

Returns:
True if the filter has been satisfied, false otherwise.
Exceptions:
SoamException 

Implements TaskOutputFilter.

virtual void enableValidation SoamBool    shouldEnable throw (SoamException) [virtual]
 

Enables or disables filter validation. By default, filter validation is disabled.

If filter validation is enabled, Symphony will check whether this filter, in isolation, can possibly be satisfied at the time that the Session::fetchTaskOutput() call is made. This check will not take into account whether concurrent filter requests invalidate one another. Note that there may be some performance degradation for filter validation.

Parameters:
shouldEnable  [IN] - Flag indicating whether to enable filter validation or not.
Exceptions:
SoamException 

Implements TaskOutputFilter.



     
Date Modified: 28 Apr 2011
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2009 Platform Computing Corporation. All rights reserved.