OSID Logo
OSID Specifications
sequencing package
Version 3.1.0
Interfaceosid.sequencing.ChainList
Implementsosid.OsidList
Used Byosid.sequencing.ChainAntimatroidSession
osid.sequencing.ChainLookupSession
osid.sequencing.ChainQuerySession
osid.sequencing.ChainSearchResults
Description

Like all OsidLists, ChainList provides a means for accessing Chain elements sequentially either one at a time or many at a time. Examples:

while (cl.hasNext()) {
     Chain chain = cl.getNextChain();
}
                
or
while (cl.hasNext()) {
     Chain[] chains = cl.getNextChains(cl.available());
}
                
MethodgetNextChain
Description

Gets the next Chain in this list.

Returnosid.sequencing.Chain the next Chain in this list. The hasNext() method should be used to test that a next Chain is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextChains
Description

Gets the next set of Chain elements in this list. The specified amount must be less than or equal to the return from available().

Parameterscardinaln the number of Chain elements requested which must be less than or equal to available()
Returnosid.sequencing.Chain[] an array of Chain elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.