Interface IssueProcessorList

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

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

while (ipl.hasNext()) {
     IssueProcessor issueProcessor = ipl.getNextIssueProcessor();
}

or

while (ipl.hasNext()) {
     IssueProcessor[] issueProcessors = ipl.getNextIssueProcessors(ipl.available());
}

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

  • Method Details

    • getNextIssueProcessor

      IssueProcessor getNextIssueProcessor() throws OperationFailedException
      Gets the next IssueProcessor in this list.
      Returns:
      the next IssueProcessor in this list. The hasNext() method should be used to test that a next IssueProcessor 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.

    • getNextIssueProcessors

      IssueProcessor[] getNextIssueProcessors(long n) throws OperationFailedException
      Gets the next set of IssueProcessor elements in this list. The specified amount must be less than or equal to the return from available().
      Parameters:
      n - the number of IssueProcessor elements requested which must be less than or equal to available()
      Returns:
      an array of IssueProcessor 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.