Interface ResourceRelationshipPeerList

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

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

while (rrpl.hasNext()) {
     ResourceRelationshipPeer peer = rrpl.getNextResourceRelationshiPeer();
}
or 
while (rrpl.hasNext()) {
     ResourceRelationshipPeer[] peers = rrpl.getNextResourceRelationshipPeers(rrpl.available());
}

  • Method Details

    • getNextResourceRelationshipPeer

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

    • getNextResourceRelationshipPeers

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