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

Platform Symphony 5.0 Java API Reference

com.platform.symphony.soam
Class TaskOutputFilter

java.lang.Object
  extended by com.platform.symphony.soam.TaskOutputFilter
Direct Known Subclasses:
TaskIdFilter

public abstract class TaskOutputFilter
extends java.lang.Object

Abstract base class for a task output filter. A task output filter sets the criteria as to which task outputs to retrieve.


Constructor Summary
TaskOutputFilter()
           
 
Method Summary
abstract  void enableValidation(boolean shouldEnable)
          Enables or disables filter validation.
abstract  boolean isSatisfied()
          Tests whether the filter has been satisfied.
abstract  void reset()
          Resets the filter criteria.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TaskOutputFilter

public TaskOutputFilter()
Method Detail

reset

public abstract void reset()
                    throws SoamException
Resets the filter criteria.

Throws:
SoamException

isSatisfied

public abstract boolean isSatisfied()
                             throws SoamException
Tests whether the filter has been satisfied.

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

enableValidation

public abstract void enableValidation(boolean shouldEnable)
                               throws SoamException
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 - Flag indicating whether to enable filter validation or not.
Throws:
SoamException

Version 5.0
Date Modified: -DREL_DATE=Nov 11 2009
Platform Computing. Accelerating Intelligence(TM).
Copyright (C) 2001-2009 Platform Computing Corporation. All rights reserved.