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