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