Interface AuditConstrainerList

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

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

while (cl.hasNext()) {
     AuditConstrainer constrainer = cl.getNextAuditConstrainer();
}

or

while (cl.hasNext()) {
     AuditConstrainer[] constrainers = cl.getNextAuditConstrainers(cl.available());
}

  • Method Details

    • getNextAuditConstrainer

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

    • getNextAuditConstrainers

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