OSID Logo
OSID Specifications
forum package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.PostList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pl.hasNext()) {
                          Post post = pl.getNextPost();
                     }
                     
                                 
                     
                
orp
                     
                     
                     while (bl.hasNext()) {
                          Post[] posts = pl.getNextPosts(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextPost
Description

Gets the next Post in this list.

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

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

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