OSID - osid.course.plan.PlanList Service Interface Definition

Interface	osid.course.plan.PlanList
Implements	`osid.OsidList`
Used By	`osid.course.plan.PlanCourseCatalogSession`
	`osid.course.plan.PlanLookupSession`
	`osid.course.plan.PlanQuerySession`
	`osid.course.plan.PlanSearchResults`
Description	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()); }
Method	getNextPlan
Description	Gets the next `Plan` in this list.
Return	`osid.course.plan.Plan`		the next `Plan` in this list. The `hasNext()` method should be used to test that a next `Plan` is available before calling this method.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getNextPlans
Description	Gets the next set of `Plan` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Plan` elements requested which must be less than or equal to `available()`
Return	`osid.course.plan.Plan[]`		an array of `Plan` elements. The length of the array is less than or equal to the number specified.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.