Interface PostList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface PostList extends OsidList

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());
}

Like all OsidLists, PostList is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getNextPost

      Post getNextPost() throws OperationFailedException
      Gets the next Post in this list.
      Returns:
      the next Post in this list. The hasNext() method should be used to test that a next Post is available before calling this method.
      Throws:
      IllegalStateException - no more elements available in this list
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getNextPosts

      Post[] getNextPosts(long n) throws OperationFailedException
      Gets the next set of Post elements in this list. The specified amount must be less than or equal to the return from available().
      Parameters:
      n - the number of Post elements requested which must be less than or equal to available()
      Returns:
      an array of Post elements. The length of the array is less than or equal to the number specified.
      Throws:
      IllegalStateException - no more elements available in this list
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.