OSID Logo
OSID Specifications
course chronicle package
Version 3.1.0
Interfaceosid.course.chronicle.CredentialEntryList
Implementsosid.OsidList
Used Byosid.course.chronicle.AcademicRecordSession
osid.course.chronicle.CredentialEntryCourseCatalogSession
osid.course.chronicle.CredentialEntryLookupSession
osid.course.chronicle.CredentialEntryQuerySession
osid.course.chronicle.CredentialEntrySearchResults
Description

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

while (cel.hasNext()) {
     CredentialEntry entry = cel.getNextCredentialEntry();
}
                
or
while (cel.hasNext()) {
     CredentialEntry[] entry = cel.getNextCredentialEntries(cel.available());
}
                
MethodgetNextCredentialEntry
Description

Gets the next CredentialEntry in this list.

Returnosid.course.chronicle.CredentialEntry the next CredentialEntry in this list. The hasNext() method should be used to test that a next CredentialEntry 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.
MethodgetNextCredentialEntries
Description

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

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