Interface RelevancyList

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

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

while (rl.hasNext()) {
     Relevancy relevancy = rl.getNextRelevancy();
}
or 
while (rl.hasNext()) {
     Relevancy[] relevancies = rl.getNextRelevancies(rl.available());
}

  • Method Summary

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

    • getNextRelevancy

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

    • getNextRelevancies

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