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