OSID Logo
OSID Specifications
forum package
Version 3.1.0
Interfaceosid.forum.ForumNodeList
Implementsosid.OsidList
Used Byosid.forum.ForumNode
Description

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

while (fnl.hasNext()) {
     ForumNode node = fnl.getNextForumNode();
}
                
or
while (fnl.hasNext()) {
     ForumNode[] nodes = fnl.getNextForumNodes(fnl.available());
}
                
MethodgetNextForumNode
Description

Gets the next ForumNode in this list.

Returnosid.forum.ForumNode the next ForumNode in this list. The hasNext() method should be used to test that a next ForumNode 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.
MethodgetNextForumNodes
Description

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

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