OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.IssueList
Implementsosid.OsidList
Description

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

                     
                     
                     while (il.hasNext()) {
                          Issue issue = il.getNextIssue();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (il.hasNext()) {
                          Issue[] issues = il.getNextIssues(il.available());
                     }
                     
                                 
                     
                
MethodgetNextIssue
Description

Gets the next Issue in this list.

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

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

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