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