Interface AuthorizationEnablerList

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

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

while (ael.hasNext()) {
     AuthorizationEnabler enabler = ael.getNextAuthorizationEnabler();
}
or 
while (ael.hasNext()) {
     AuthorizationEnabler[] enablers = ael.getNextAuthorizationEnablers(ael.available());
}

  • Method Details

    • getNextAuthorizationEnabler

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

    • getNextAuthorizationEnablers

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