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