| Interface | osid.authentication.AgencySearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The interface for governing agency searches. | ||
| Method | searchAmongAgencies | ||
| Description |
Execute this search among the given list of agencies. | ||
| Parameters | osid.id.IdList | agencyIds | list of agencies |
| Errors | NULL_ARGUMENT | agencyIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderAgencyResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.authentication.AgencySearchOrder | agencySearchOrder | agency search order |
| Errors | NULL_ARGUMENT | agencySearchOrder is null | |
| UNSUPPORTED | agencySearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgencySearchRecord | ||
| Description |
Gets the record corresponding to the given agency
search record | ||
| Parameters | osid.type.Type | agencySearchRecordType | an agency search record type |
| Return | osid.authentication.records.AgencySearchRecord | the agency search record | |
| Errors | NULL_ARGUMENT | agencySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(agencySearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |