OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.CredentialList
Implementsosid.OsidList
Description

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

                     
                     
                     while (cl.hasNext()) {
                          Credential credential = cl.getNextCredential();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Credential[] credentials = cl.getNextCredentials(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextCredential
Description

Gets the next Credential in this list.

Returnosid.course.program.Credentialthe next Credential in this list. The hasNext() method should be used to test that a next Credential is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextCredentials
Description

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

Parameterscardinalnthe number of Credential elements requested which must be less than or equal to available()
Returnosid.course.program.Credential[]an array of Credential 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.