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