OSID - osid.subscription.PublisherList Service Interface Definition

Interface	osid.subscription.PublisherList
Implements	`osid.OsidList`
Used By	`osid.subscription.DispatchPublisherSession`
	`osid.subscription.PublisherHierarchySession`
	`osid.subscription.PublisherLookupSession`
	`osid.subscription.PublisherQuerySession`
	`osid.subscription.PublisherSearchResults`
	`osid.subscription.SubscriptionPublisherSession`
	`osid.subscription.rules.DispatchConstrainerEnablerPublisherSession`
	`osid.subscription.rules.DispatchConstrainerPublisherSession`
	`osid.subscription.rules.DispatchEnablerPublisherSession`
	`osid.subscription.rules.DispatchProcessorEnablerPublisherSession`
	show 2 more…
`osid.subscription.rules.DispatchProcessorPublisherSession`
`osid.subscription.rules.SubscriptionEnablerPublisherSession`
Description	Like all `OsidLists` , `PublisherList` provides a means for accessing `Publisher` elements sequentially either one at a time or many at a time. Examples: while (pl.hasNext()) { Publisher publisher = pl.getNextPublisher(); } or while (pl.hasNext()) { Publisher[] publishers = pl.getNextPublishers(pl.available()); }
Method	getNextPublisher
Description	Gets the next `Publisher` in this list.
Return	`osid.subscription.Publisher`		the next `Publisher` in this list. The `hasNext()` method should be used to test that a next `Publisher` 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	getNextPublishers
Description	Gets the next set of `Publisher` elements in this list. The specified amount must be less than or equal to the return from `available()` .
Parameters	`cardinal`	`n`	the number of `Publisher` elements requested which must be less than or equal to `available()`
Return	`osid.subscription.Publisher[]`		an array of `Publisher` 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.