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