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

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

                     
                     
                     while (rl.hasNext()) {
                          Reply reply = rl.getNextReply();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rl.hasNext()) {
                          Reply[] replies = rl.getNextRepliess(rl.available());
                     }
                     
                                 
                     
                
MethodgetNextReply
Description

Gets the next Reply in this list.

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

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

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