Interface ActivityRegistrationPeerList

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

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

while (arpl.hasNext()) {
     ActivityRegistrationPeer peer = arpl.getNextActivityRegistrationPeer();
}
or 
while (arpl.hasNext()) {
     ActivityRegistrationPeer[] peers = arpl.getNextActivityRegistrationPeers(arpl.available());
}

  • Method Details

    • getNextActivityRegistrationPeer

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

    • getNextActivityRegistrationPeers

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