|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A federated iterator is used to iterate over the collective members of DKFederatedCollection across collection boundaries. The next() method will returns DDO objects until all collections are iterated over. This iterator is created by invoking the method createIterator() in the DKFederatedCollection object.
dkIterator
,
DKSequentialIterator
Method Summary | |
java.lang.Object |
at()
Returns the current element in the collection without moving the iterator position. |
boolean |
more()
Returns true if there are more elements in the DKFederatedCollection. |
java.lang.Object |
next()
Returns the current element in the collection and advances the iterator to the next position. |
java.lang.Object |
previous()
Returns the current element in the collection and moves the iterator backward one position. |
void |
reset()
Resets the iterator to the beginning of DKFederatedCollection. |
boolean |
setToFirst()
Set the iterator to the first element in this federated collection. |
boolean |
setToFirstCollection()
Set the iterator to the first element in the first collection in this federated collection. |
boolean |
setToLast()
Set the iterator to the last element in this federated collection. |
boolean |
setToLastCollection()
Set the iterator to the last element in the last collection in this federated collection. |
boolean |
setToNext()
Set the iterator to the next element in this federated collection. |
boolean |
setToNextCollection()
Set the iterator to the first element in the next collection in this federated collection. |
boolean |
setToPrevious()
Set the iterator to the previous element in this federated collection. |
boolean |
setToPreviousCollection()
Set the iterator to the last element in the previous collection in this federated collection. |
Method Detail |
public java.lang.Object next() throws DKUsageError
next
in interface dkIterator
DKUsageError
- if already at the last item in collecctionpublic void reset()
reset
in interface dkIterator
public boolean more()
more
in interface dkIterator
com.ibm.mm.sdk.common.dkIterator
public java.lang.Object previous() throws DKUsageError
previous
in interface DKSequentialIterator
DKUsageError
- if already at the first item in collecctionpublic java.lang.Object at() throws DKUsageError
at
in interface DKSequentialIterator
DKUsage
- if collection is empty, or current position is invalidpublic boolean setToFirst()
setToFirst
in interface DKSequentialIterator
com.ibm.mm.sdk.common.DKSequentialIterator
public boolean setToLast()
setToLast
in interface DKSequentialIterator
com.ibm.mm.sdk.common.DKSequentialIterator
public boolean setToNext()
setToNext
in interface DKSequentialIterator
com.ibm.mm.sdk.common.DKSequentialIterator
public boolean setToPrevious()
setToPrevious
in interface DKSequentialIterator
com.ibm.mm.sdk.common.DKSequentialIterator
public boolean setToFirstCollection()
public boolean setToLastCollection()
public boolean setToNextCollection()
public boolean setToPreviousCollection()
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |