OSID - osid.personnel.RealmList Service Interface Definition

Interface	osid.personnel.RealmList
Implements	`osid.OsidList`
Used By	`osid.personnel.AppointmentRealmSession`
	`osid.personnel.OrganizationRealmSession`
	`osid.personnel.PersonRealmSession`
	`osid.personnel.PositionRealmSession`
	`osid.personnel.RealmHierarchySession`
	`osid.personnel.RealmLookupSession`
	`osid.personnel.RealmQuerySession`
	`osid.personnel.RealmSearchResults`
Description	Like all `OsidLists` , `RealmList` provides a means for accessing `Realm` elements sequentially either one at a time or many at a time. Examples: while (rl.hasNext()) { Realm realm = rl.getNextRealm(); } or while (rl.hasNext()) { Realm[] realm = rl.getNextRealms(rl.available()); }
Method	getNextRealm
Description	Gets the next `Realm` in this list.
Return	`osid.personnel.Realm`		the next `Realm` in this list. The `hasNext()` method should be used to test that a next `Realm` 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	getNextRealms
Description	Gets the next set of `Realm` elements in this list. The specified amount must be less than or equal to the return from `available()` .
Parameters	`cardinal`	`n`	the number of `Realm` elements requested which must be less than or equal to `available()`
Return	`osid.personnel.Realm[]`		an array of `Realm` 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.