OSID - osid.course.program.ProgramList Service Interface Definition

Interface	osid.course.program.ProgramList
Implements	`osid.OsidList`
Used By	`osid.course.program.CourseProgramLookupSession`
	`osid.course.program.ProgramCourseCatalogSession`
	`osid.course.program.ProgramLookupSession`
	`osid.course.program.ProgramQuerySession`
	`osid.course.program.ProgramSearchResults`
Description	Like all `OsidLists`, `ProgramList` provides a means for accessing `Program` elements sequentially either one at a time or many at a time. Examples: while (pl.hasNext()) { Program program = pl.getNextProgram(); } or while (pl.hasNext()) { Program[] programs = pl.getNextPrograms(pl.available()); }
Method	getNextProgram
Description	Gets the next `Program` in this list.
Return	`osid.course.program.Program`		the next `Program` in this list. The `hasNext()` method should be used to test that a next `Program` 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	getNextPrograms
Description	Gets the next set of `Program` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Program` elements requested which must be less than or equal to `available()`
Return	`osid.course.program.Program[]`		an array of `Program` 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.