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