OSID - osid.subscription.DispatchList Service Interface Definition

Interface	osid.subscription.DispatchList
Implements	`osid.OsidList`
Used By	`osid.subscription.DispatchLookupSession`
	`osid.subscription.DispatchPublisherSession`
	`osid.subscription.DispatchQuerySession`
	`osid.subscription.DispatchSearchResults`
	`osid.subscription.rules.DispatchConstrainerRuleLookupSession`
	`osid.subscription.rules.DispatchEnablerRuleLookupSession`
	`osid.subscription.rules.DispatchProcessorRuleLookupSession`
Description	Like all `OsidLists` , `DispatchList` provides a means for accessing `Dispatch` elements sequentially either one at a time or many at a time. Examples: while (dl.hasNext()) { Dispatch dispatch = dl.getNextDispatch(); } or while (dl.hasNext()) { Dispatch[] dispatches = dl.getNextDispatches(dl.available()); }
Method	getNextDispatch
Description	Gets the next `Dispatch` in this list.
Return	`osid.subscription.Dispatch`		the next `Dispatch` in this list. The `hasNext()` method should be used to test that a next `Dispatch` 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	getNextDispatches
Description	Gets the next set of `Dispatch` elements in this list. The specified amount must be less than or equal to the return from `available()` .
Parameters	`cardinal`	`n`	the number of `Dispatch` elements requested which must be less than or equal to `available()`
Return	`osid.subscription.Dispatch[]`		an array of `Dispatch` 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.