com.qizx.api
Interface LibraryMemberIterator

public interface LibraryMemberIterator

Iterator returned by functions searching Documents or Collections inside a Library.

Typically such an iterator is used like this:

  // obtain an iterator: (could be also through queryProperties())
 LibraryMemberIterator iter = collection.getChildren();
  // iterate on members:
 while(iter.moveToNextMember()) {
     LibraryMember current = iter.getCurrentMember();
     // do something with library member...
 }
 

Method Summary

LibraryMember	getCurrentMember() Returns the current item.
boolean	moveToNextMember() Attempts to move to the next member.
LibraryMemberIterator	reborn() Returns a clone of the iterator in its initial state.

Method Detail

moveToNextMember

public boolean moveToNextMember()

Attempts to move to the next member. If true is returned, this member is available through getCurrentMember().

Returns:

true if a next member is found.

getCurrentMember

public LibraryMember getCurrentMember()

Returns the current item. If moveToNextMember() has not been called or has returned false, the result is undefined.

Returns:

a Library member if called after a moveToNextMember returning true

reborn

public LibraryMemberIterator reborn()

Returns a clone of the iterator in its initial state.

Returns:

a new copy of this object, positioned before first item