org.osid.hold

Interface IssueList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface IssueList
extends OsidList

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

       
       
       while (il.hasNext()) {
            Issue issue = il.getNextIssue();
       }
       
                   
       
  

or

       
       
       while (il.hasNext()) {
            Issue[] issues = il.getNextIssues(il.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Issue	getNextIssue() Gets the next Issue in this list.
Issue[]	getNextIssues(long n) Gets the next set of Issue elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextIssue

Issue getNextIssue()
                   throws OperationFailedException

Gets the next Issue in this list.

Returns:

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

getNextIssues

Issue[] getNextIssues(long n)
                      throws OperationFailedException

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

Parameters:

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

Returns:

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