OSID - osid.forum.ForumList Service Interface Definition

Interface	osid.forum.ForumList
Implements	`osid.OsidList`
Used By	`osid.forum.ForumHierarchySession`
	`osid.forum.ForumLookupSession`
	`osid.forum.ForumQuerySession`
	`osid.forum.ForumSearchResults`
	`osid.forum.PostForumSession`
Description	Like all `OsidLists` , `ForumList` provides a means for accessing `Forum` elements sequentially either one at a time or many at a time. Examples: while (fl.hasNext()) { Forum forum = fl.getNextForum(); } or while (fl.hasNext()) { Forum[] forums = fl.getNextForums(fl.available()); }
Method	getNextForum
Description	Gets the next `Forum` in this list.
Return	`osid.forum.Forum`		the next `Forum` in this list. The `hasNext()` method should be used to test that a next `Forum` 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	getNextForums
Description	Gets the next set of `Forum` elements in this list. The specified amount must be less than or equal to the return from `available()` .
Parameters	`cardinal`	`n`	the number of `Forum` elements requested which must be less than or equal to `available()`
Return	`osid.forum.Forum[]`		an array of `Forum` 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.