Interface ObjectiveList

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

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

while (ol.hasNext()) {
     Objective objective = ol.getNextObjective();
}
or 
while (ol.hasNext()) {
     Objective[] objectives = ol.getNextObjectives(ol.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    Objective
    getNextObjective()
    Gets the next Objective in this list.
    Objective[]
    getNextObjectives(long n)
    Gets the next set of Objective elements in this list which must be less than or equal to the number returned 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

    • getNextObjective

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

    • getNextObjectives

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