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

Main Page   Class Hierarchy   Compound List   Compound Members  

TaskOutputFilter Class Reference

Interface for a task output filter. A task output filter sets the criteria as to which task outputs to retrieve. More...

Inheritance diagram for TaskOutputFilter:

TaskIdFilter List of all members.

Public Methods

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

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

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

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


Protected Methods

 TaskOutputFilter ()
 Constructs a TaskOutputFilter object.


Friends

class Session

Detailed Description

Interface for a task output filter. A task output filter sets the criteria as to which task outputs to retrieve.


Constructor & Destructor Documentation

virtual ~TaskOutputFilter void    [virtual]
 

Destructor for a TaskOutputFilter object.

TaskOutputFilter   [protected]
 

Constructs a TaskOutputFilter object.


Member Function Documentation

virtual void reset   throw (SoamException) [pure virtual]
 

Resets the filter criteria.

Exceptions:
SoamException 

Implemented in TaskIdFilter.

virtual SoamBool isSatisfied   throw (SoamException) [pure virtual]
 

Tests whether the filter has been satisfied.

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

Implemented in TaskIdFilter.

virtual void enableValidation SoamBool    shouldEnable throw (SoamException) [pure 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 

Implemented in TaskIdFilter.



     
Date Modified: 3 Nov 2008
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

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