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