| Interface | osid.transaction.batch.AliasResponseList | ||
|---|---|---|---|
| Implements | osid.OsidList | ||
| Description |
Like all
AliasResponseList
provides a means for accessing AliasResponse
elements sequentially either one at a time or many at a time.
Examples:
while arl.hasNext()) {
AliasResponse response = arl.getNextAliasResponse();
}
or
while (arl.hasNext()) {
AliasResponse[] responses = arl.getNextAliasResponses(arl.available());
}
| ||
| Method | getNextAliasResponse | ||
| Description |
Gets the next | ||
| Return | osid.transaction.batch.AliasResponse | the next AliasResponse in this list. The hasNext()
method should be used to test that a next AliasResponse
is available before calling this method. | |
| Errors | ILLEGAL_STATE | no more elements available in this list | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getNextAliasResponses | ||
| Description |
Gets the next set of | ||
| Parameters | cardinal | n | the number of AliasResponse elements requested which must be
less than or equal to available() |
| Return | osid.transaction.batch.AliasResponse[] | an array of AliasResponse elements. The
length of the array is less than or equal to the number specified. | |
| Errors | ILLEGAL_STATE | no more elements available in this list | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |