public interface OrganizationList extends OsidList
Like all OsidLists,
OrganizationList
provides a means for accessing Organization
elements
sequentially either one at a time or many at a time. Examples:
while (ol.hasNext()) { Organization organization = ol.getNextOrganization(); }or
while (ol.hasNext()) { Organization[] organizations = ol.getNextOrganizations(ol.available()); }
Modifier and Type | Method and Description |
---|---|
Organization |
getNextOrganization()
Gets the next
Organization in this list. |
Organization[] |
getNextOrganizations(long n)
Gets the next set of
Organization elements in this
list. |
Organization getNextOrganization() throws OperationFailedException
Organization
in this list. Organization
in this list. The
hasNext()
method should be used to test that a next
Organization
is available before calling this
method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Organization[] getNextOrganizations(long n) throws OperationFailedException
Organization
elements in this
list. The specified amount must be less than or equal to the return
from available().
n
- the number of Organization
elements requested
which must be less than or equal to available()
Organization
elements.
The length of the array is less than or equal to the
number specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.