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