public interface PersonList extends OsidList
Like all OsidLists,
PersonList
provides a
means for accessing Person
elements sequentially either one
at a time or many at a time. Examples:
while (pl.hasNext()) { Person person = pl.getNextPerson(); }or
while (pl.hasNext()) { Person[] persons = pl.getNextPersons(pl.available()); }
Modifier and Type | Method and Description |
---|---|
Person |
getNextPerson()
Gets the next
Person in this list. |
Person[] |
getNextPersons(long n)
Gets the next set of
Person elements in this list. |
Person getNextPerson() throws OperationFailedException
Person
in this list. Person
in this list. The
hasNext()
method should be used to test that a next
Person
is available before calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Person[] getNextPersons(long n) throws OperationFailedException
Person
elements in this list. The
specified amount must be less than or equal to the return from
available().
n
- the number of Person
elements requested which
must be less than or equal to available()
Person
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.