OSID Logo
OSID Specifications
tracking batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.batch.SubtaskIssuePeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (sipl.hasNext()) {
                          SubtaskIssuePeer peer = sipl.getNextSubtaskissuePeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sipl.hasNext()) {
                          SubtaskIssuePeer[] peers = sipl.getNextSubtaskIssuePeers(ispl.available());
                     }
                     
                                 
                     
                
MethodgetNextSubtaskIssuePeer
Description

Gets the next SubtaskIssuePeer in this list.

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

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

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