Interface RepositoryList

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

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

while (rl.hasNext()) {
     Repository repository = rl.getNextRepository();
}
or 
while (rl.hasNext()) {
     Repository[] repositories = rl.getNextRepositories(rl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    Repository[]
    getNextRepositories(long n)
    Gets the next set of Repository elements in this list which must be less than or equal to the return from available() .
    Repository
    getNextRepository()
    Gets the next Repository 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

    • getNextRepository

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

    • getNextRepositories

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