Interface ParameterList

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

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

while (pl.hasNext()) {
     Parameter parameter = pl.getNextParameter();
}
or 
while (pl.hasNext()) {
     Parameter[] parameters = pl.getNextParameters(pl.available());
}

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

  • Method Details

    • getNextParameter

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

    • getNextParameters

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