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