OSID - osid.voting.batch.CandidateBatchFormList Service Interface Definition

Interface	osid.voting.batch.CandidateBatchFormList
Implements	`osid.OsidList`
Used By	`osid.voting.batch.CandidateBatchAdminSession`
Description	Like all `OsidLists`, `CandidateBatchFormList` provides a means for accessing `CandidateBatchForm` elements sequentially either one at a time or many at a time. Examples: while (cbfl.hasNext()) { CandidateBatchForm form = cbfl.getNextCandidateBatchForm(); } or while (cbfl.hasNext()) { CandidateBatchForm[] forms = cbfl.getNextCandidateBatchForms(cbfl.available()); }
Method	getNextCandidateBatchForm
Description	Gets the next `CandidateBatchForm` in this list.
Return	`osid.voting.batch.CandidateBatchForm`		the next `CandidateBatchForm` in this list. The `hasNext()` method should be used to test that a next `CandidateBatchForm` 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	getNextCandidateBatchForms
Description	Gets the next set of `CandidateBatchForm` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `CandidateBatchForm` elements requested which must be less than or equal to `available()`
Return	`osid.voting.batch.CandidateBatchForm[]`		an array of `CandidateBatchForm` 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.