Interface ResourceList

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

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

while (rl.hasNext()) {
     Resource resource = rl.getNextResource();
}
or 
while (rl.hasNext()) {
     Resource[] resources = rl.getNextResources(rl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    Resource
    getNextResource()
    Gets the next Resource in this list.
    Resource[]
    getNextResources(long n)
    Gets the next set of Resources 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

    • getNextResource

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

    • getNextResources

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