OSID Logo
OSID Specifications
commenting package
Version 3.1.0
Interfaceosid.commenting.CommentList
Implementsosid.OsidList
Used Byosid.commenting.CommentBookSession
osid.commenting.CommentLookupSession
osid.commenting.CommentQuerySession
osid.commenting.CommentSearchResults
Description

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

while (cl.hasNext()) {
     Comment comment = cl.getNextComment();
}
                
or
while (cl.hasNext()) {
     Comment[] comments = cl.getNextComments(cl.available());
}
                
MethodgetNextComment
Description

Gets the next Comment in this list.

Returnosid.commenting.Comment the next Comment in this list. The hasNext() method should be used to test that a next Comment is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextComments
Description

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

Parameterscardinaln the number of Comment elements requested which must be less than or equal to available()
Returnosid.commenting.Comment[] an array of Comment elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.