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