com.ibm.ia.testdriver.data

Interface EntitySourceIterator<T>

Type Parameters:

T - The type of meta data object related to each entity returned by this entity source iterator. An object of this type is returned by the getRelatedEntityMetaData(String, String) method.

All Superinterfaces:

java.util.Iterator<Entity>

public interface EntitySourceIterator<T>
extends java.util.Iterator<Entity>

An iterator for an EntitySource. This represents a ordered traversal of the entities within an EntitySource. Repeatable ordering of entities returned by instances of the iterator may be affected by restrictions on individual implementations and should be defined by the iterator implementor.

Method Summary

Methods

Modifier and Type	Method and Description
T	getRelatedEntityMetaData(java.lang.String entityType, java.lang.String entityID) Retrieves the meta data related to an entity supplied by the entity source.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

getRelatedEntityMetaData

T getRelatedEntityMetaData(java.lang.String entityType,
                         java.lang.String entityID)

Retrieves the meta data related to an entity supplied by the entity source. This allows results returned from TestDriver to be linked to any pertinent meta data associated with the creation of the entity that the result is related to.

Parameters:

entityType - The entity type.

entityID - The entity ID.

Returns:

Data related to the entity.