OSID - osid.journaling.BranchList Service Interface Definition

Interface	osid.journaling.BranchList
Implements	`osid.OsidList`
Used By	`osid.journaling.BranchLookupSession`
	`osid.journaling.BranchQuerySession`
	`osid.journaling.BranchSearchResults`
Description	Like all `OsidLists`, `BranchList` provides a means for accessing `Branch` elements sequentially either one at a time or many at a time. Examples: while (bl.hasNext()) { Branch branch = bl.getNextBranch(); } or while (rl.hasNext()) { Branch[] branches = bl.getNextBranches(bl.available()); }
Method	getNextBranch
Description	Gets the next `Branch` in this list.
Return	`osid.journaling.Branch`		the next `Branch` in this list. The `hasNext()` method should be used to test that a next `Branch` 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	getNextBranches
Description	Gets the next set of `Branches` in this list which must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Branch` elements requested which must be less than or equal to `available()`
Return	`osid.journaling.Branch[]`		an array of `Branch` 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.