| Interface | osid.transaction.batch.AliasRequestList | ||
|---|---|---|---|
| Implements | osid.OsidList | ||
| Description |
Like all
AliasRequestList
provides a means for accessing AliasRequest
elements sequentially either one at a time or many at a time.
Examples:
while arl.hasNext()) {
AliasRequest request = arl.getNextAliasRequest();
}
or
while (arl.hasNext()) {
AliasRequest[] requests = arl.getNextAliasRequests(arl.available());
}
| ||
| Method | getNextAliasRequest | ||
| Description |
Gets the next | ||
| Return | osid.transaction.batch.AliasRequest | the next AliasRequest in this list. The hasNext()
method should be used to test that a next AliasRequest
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 | getNextAliasRequests | ||
| Description |
Gets the next set of | ||
| Parameters | cardinal | n | the number of AliasRequest elements requested which must be
less than or equal to available() |
| Return | osid.transaction.batch.AliasRequest[] | an array of AliasRequest 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. | |