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