OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.SubjectList
Implementsosid.OsidList
Description

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

                     
                     
                     while (sl.hasNext()) {
                          Subject subject = sl.getNextSubject();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sl.hasNext()) {
                          Subject[] subjects = sl.getNextSubjects(sl.available());
                     }
                     
                                 
                     
                
MethodgetNextSubject
Description

Gets the next Subject in this list.

Returnosid.ontology.Subjectthe next Subject in this list. The hasNext() method should be used to test that a next Subject is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextSubjects
Description

Gets the next set of Subject elements in this list which must be less than or equal to the number returned from available().

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