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