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