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

Platform Symphony 5.1 Java API Reference

com.platform.symphony.soam
Interface EnumItems


public interface EnumItems

A container that holds completed task results.

Provides access to a series of TaskOutputHandle elements, one at a time. Successive calls to the getNext method return successive elements in the series.

Session.fetchTaskOutput will return an EnumItems object, which can be used to iterate through the task responses received from Symphony.

      EnumItems enumOutput = session.fetchTaskOutput(numTasks);
      TaskOutputHandle output = enumOutput.getNext();
      while (output != null)
      {
          ......
          output = enumOutput.getNext();
      }
 
NOTE: If any of the methods of this interface 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:
Session.fetchTaskOutput(long), TaskOutputHandle

Method Summary
 long getCount()
          Retrieves the number of items in the enumeration.
 TaskOutputHandle getNext()
          Returns the next item in the enumeration, or null if there are no more items.
 void reset()
          Resets the enumeration position to the beginning of the series.
 void skip(long skipCount)
          Skips over the next skipCount items in the enumeration.
 

Method Detail

getNext

TaskOutputHandle getNext()
                         throws SoamException
Returns the next item in the enumeration, or null if there are no more items.

Returns:
The next TaskOutputHandle in the enumeration, or null if there are no more items.
Throws:
SoamException

reset

void reset()
           throws SoamException
Resets the enumeration position to the beginning of the series. A subsequent call to getNext will result in the first item being returned.

Throws:
SoamException

skip

void skip(long skipCount)
          throws SoamException
Skips over the next skipCount items in the enumeration. If the skipCount is greater than the number of items left to enumerate, the enumerator position will be set to the end of the series.

Parameters:
skipCount - The number of items to skip over in the enumeration. It must greater than or equal to 0.
Throws:
SoamException

getCount

long getCount()
              throws SoamException
Retrieves the number of items in the enumeration.

Returns:
The number of items in the enumeration
Throws:
SoamException

Version 5.1
Date Modified: -DREL_DATE=Apr 28 2011
Platform Computing. Accelerating Intelligence(TM).
Copyright (C) 2001-2009 Platform Computing Corporation. All rights reserved.