Interface AuthorizationResourcePeerList

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

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

while (arpl.hasNext()) {
     AuthorizationResourcePeer peer = arpl.getNextAuthorizationResourcePeer();
}
or 
while (arpl.hasNext()) {
     AuthorizationResourcePeer[] peers = arpl.getNextAuthorizationResourcePeers(arpl.available());
}

  • Method Details

    • getNextAuthorizationResourcePeer

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

    • getNextAuthorizationResourcePeers

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