Interface ActivityRegistrationList

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

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

while (arl.hasNext()) {
     ActivityRegistration registration = arl.getNextActivityRegistration();
}
or 
while (arl.hasNext()) {
     ActivityRegistration[] registrations = arl.getNextActivityRegistrations(arl.available());
}

  • Method Details

    • getNextActivityRegistration

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

    • getNextActivityRegistrations

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