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