OSID Logo
OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.sequencing.ChainList
Implementsosid.OsidList
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.Chainthe next Chain in this list. The hasNext() method should be used to test that a next Chain is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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().

Parameterscardinalnthe 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_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.