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

Platform Symphony 5.0 Java API Reference

com.platform.symphony.soam
Class TaskIdFilter

java.lang.Object
  extended by com.platform.symphony.soam.TaskOutputFilter
      extended by com.platform.symphony.soam.TaskIdFilter

public class TaskIdFilter
extends TaskOutputFilter

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

See Also:
TaskOutputFilter

Constructor Summary
TaskIdFilter()
          Constructs a TaskIdFilter object.
 
Method Summary
 boolean addId(java.lang.String id)
          Adds the specified task ID to the filter.
 void enableValidation(boolean shouldEnable)
          Enables or disables filter validation.
 boolean isSatisfied()
          Tests whether the filter has been satisfied.
 boolean removeId(java.lang.String id)
          Removes the specified task ID from the filter.
 void reset()
          Resets the filter criteria.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TaskIdFilter

public TaskIdFilter()
Constructs a TaskIdFilter object.

Method Detail

addId

public boolean addId(java.lang.String id)
              throws SoamException
Adds the specified task ID to the filter.

Parameters:
id - 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.
Throws:
SoamException

removeId

public boolean removeId(java.lang.String id)
                 throws SoamException
Removes the specified task ID from the filter.

Parameters:
id - 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.
Throws:
SoamException

reset

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

Specified by:
reset in class TaskOutputFilter
Throws:
SoamException

isSatisfied

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

Specified by:
isSatisfied in class TaskOutputFilter
Returns:
True if the filter has been satisfied, false otherwise.
Throws:
SoamException

enableValidation

public 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.

Specified by:
enableValidation in class TaskOutputFilter
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.