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