public interface ForumList extends OsidList
Like all OsidLists,
ForumList
provides a
means for accessing Forum
elements sequentially either one
at a time or many at a time. Examples:
while (fl.hasNext()) { Forum forum = fl.getNextForum(); }or
while (fl.hasNext()) { Forum[] forums = fl.getNextForums(fl.available()); }
Modifier and Type | Method and Description |
---|---|
Forum |
getNextForum()
Gets the next
Forum in this list. |
Forum[] |
getNextForums(long n)
Gets the next set of
Forum elements in this list. |
Forum getNextForum() throws OperationFailedException
Forum
in this list. Forum
in this list. The
hasNext()
method should be used to test that a next
Forum
is available before calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Forum[] getNextForums(long n) throws OperationFailedException
Forum
elements in this list. The
specified amount must be less than or equal to the return from
available().
n
- the number of Forum
elements requested which
must be less than or equal to available()
Forum
elements.
The
length of the array is less than or equal to the number
specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.