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

Main Page   Class Hierarchy   Compound List   Compound Members  

ExecutionEnumItems Class Reference

A collection of ExecutionStatus objects. More...

List of all members.


Public Methods

bool getNext (ExecutionStatusPtr &status) throw (SoamException)
 Returns the next item in the enumeration.

void reset () throw (SoamException)
 Resets the enumeration position to the beginning of the series.

void skip (SoamULong skipCount) throw (SoamException)
 Skips over the next skipCount items in the collection.

SoamULong getCount () throw (SoamException)
 Retrieves the number of items in the collection.


Detailed Description

A collection of ExecutionStatus objects.

See also:
ExecutionSession::fetchTaskStatus , ExecutionStatus


Member Function Documentation

bool getNext ExecutionStatusPtr &    status throw (SoamException)
 

Returns the next item in the enumeration.

If the enumeration’s current position is at the end, false will be returned and the ExecutionStatus will be invalid, otherwise true will be returned and the ExecutionStatus will be valid.

am[out] status - returned a <code>ExecutionStatus</code> object.
Returns:
true if there are more items in the enumeration, false otherwise.
Exceptions:
SoamException 
See also:
ExecutionStatus

void reset   throw (SoamException)
 

Resets the enumeration position to the beginning of the series.

A subsequent call to getNext will result in the first item being returned.

Exceptions:
SoamException 

void skip SoamULong    skipCount throw (SoamException)
 

Skips over the next skipCount items in the collection.

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 collection. It must greater than or equal to 0.
Exceptions:
SoamException 

SoamULong getCount   throw (SoamException)
 

Retrieves the number of items in the collection.

Returns:
The number of items in the collection.
Exceptions:
SoamException 


     
Date Modified: 11 Nov 2009
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.