public interface DistributorList extends OsidList
Like all OsidLists,
DistributorList
provides a means for accessing Distributor
elements
sequentially either one at a time or many at a time. Examples:
while (dl.hasNext()) { Distributor distributor = dl.getNextDistributor(); }or
while (dl.hasNext()) { Distributor[] distributors = dl.getNextDistributors(dl.available()); }
Modifier and Type | Method and Description |
---|---|
Distributor |
getNextDistributor()
Gets the next
Distributor in this list. |
Distributor[] |
getNextDistributors(long n)
Gets the next set of
Distributor elements in this list. |
Distributor getNextDistributor() throws OperationFailedException
Distributor
in this list. Distributor
in this list. The
hasNext()
method should be used to test that a next
Distributor
is available before calling this
method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Distributor[] getNextDistributors(long n) throws OperationFailedException
Distributor
elements in this list.
The specified amount must be less than or equal to the return from
available().
n
- the number of Distributor
elements requested
which must be less than or equal to available()
Distributor
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.