OSID - osid.contact.ContactList Service Interface Definition

Interface	osid.contact.ContactList
Implements	`osid.OsidList`
Used By	`osid.contact.ContactAddressBookSession`
	`osid.contact.ContactLookupSession`
	`osid.contact.ContactQuerySession`
	`osid.contact.ContactSearchResults`
	`osid.contact.ContactSession`
	`osid.contact.rules.ContactEnablerRuleLookupSession`
Description	Like all `OsidLists`, `ContactList` provides a means for accessing `Contact` elements sequentially either one at a time or many at a time. Examples: while (cl.hasNext()) { Contact contact = cl.getNextContact(); } or while (cl.hasNext()) { Contact[] contacts = cl.getNextContacts(cl.available()); }
Method	getNextContact
Description	Gets the next `Contact` in this list.
Return	`osid.contact.Contact`		the next `Contact` in this list. The `hasNext()` method should be used to test that a next `Contact` 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	getNextContacts
Description	Gets the next set of `Contact` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Contact` elements requested which must be less than or equal to `available()`
Return	`osid.contact.Contact[]`		an array of `Contact` 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.