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