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