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