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