OSID Specifications
authentication package
Version 3.0.0
Release Candidate Preview
authentication package
Version 3.0.0
Release Candidate Preview
| Interface | osid.authentication.AgencySearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getAgencies | ||
| Description |
Gets the agency list resultrng from a search. | ||
| Return | osid.authentication.AgencyList | the agency list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgencyQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.authentication.AgencyQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgencySearchResultsRecord | ||
| 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.AgencySearchResultsRecord | the agency search results 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. | |