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