Interface ReplyList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface ReplyList
extends OsidList

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

Method Summary

Modifier and Type	Method	Description
Reply[]	getNextReplies(long n)	Gets the next set of Reply elements in this list.
Reply	getNextReply()	Gets the next Reply in this list.

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

getNextReply

Reply getNextReply()
            throws OperationFailedException

Gets the next Reply in this list.

Returns:

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

getNextReplies

Reply[] getNextReplies(long n)
                throws OperationFailedException

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

Parameters:

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

Returns:

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