Interface BlogList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface BlogList
extends OsidList

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

while (bl.hasNext()) {
     Blog blog = bl.getNextBlog();
}            
  

or

while (bl.hasNext()) {
     Blog[] blogs = bl.getNextBlogs(bl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Blog	getNextBlog()	Gets the next Blog in this list.
Blog[]	getNextBlogs(long n)	Gets the next set of Blog elements in this list which must be less than or equal to the return from available() .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

getNextBlog

Blog getNextBlog()
          throws OperationFailedException

Gets the next Blog in this list.

Returns:

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

getNextBlogs

Blog[] getNextBlogs(long n)
             throws OperationFailedException

Gets the next set of Blog elements in this list which must be less than or equal to the return from available() .

Parameters:

n - the number of Blog elements requested which must be less than or equal to available()

Returns:

an array of Blog 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.