OSID Logo
OSID Specifications
course requisite package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.requisite.CredentialRequirementList
Implementsosid.OsidList
Description

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

                     
                     
                     while (crl.hasNext()) {
                          CredentialRequirement req = crl.getNextCredentialRequirement();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (crl.hasNext()) {
                          CredentialRequirement[] reqs = crl.getNextCredentialRequirements(crl.available());
                     }
                     
                                 
                     
                
MethodgetNextCredentialRequirement
Description

Gets the next CredentialRequirement in this list.

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

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

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