OSID Logo
OSID Specifications
assessment batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.batch.AssessmentTakenPeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (atpl.hasNext()) {
                          AssessmentTakenPeer peer = atpl.getNextAssessmentTakenPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (atpl.hasNext()) {
                          AssessmentTakenPeer[] peers = atpl.getNextAssessmentTakenPeers(atpl.available());
                     }
                     
                                 
                     
                
MethodgetNextAssessmentTakenPeer
Description

Gets the next AssessmentTakenPeer in this list.

Returnosid.assessment.batch.AssessmentTakenPeerthe next AssessmentTakenPeer in this list. The hasNext() method should be used to test that a next AssessmentTakenPeer is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextAssessmentTakenPeers
Description

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

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