| Interface | osid.authentication.AgentList | ||
|---|---|---|---|
| Implements | osid.OsidList | ||
| Description |
Like all
while (al.hasNext()) {
Agent agent = al.getNextAgent();
}
or
while (al.hasNext()) {
Agent[] agents = al.getNextAgents(al.available());
}
| ||
| Method | getNextAgent | ||
| Description |
Gets the next | ||
| Return | osid.authentication.Agent | the next Agent in this list. The hasNext()
method should be used to test that a next Agent 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 | getNextAgents | ||
| Description |
Gets the next set of | ||
| Parameters | cardinal | n | the number of Agent elements requested which should be less
than or equal to available() |
| Return | osid.authentication.Agent[] | an array of Agent 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. | |