Interface | osid.authentication.AgencySearchSession | ||
---|---|---|---|
Implements | osid.authentication.AgencyQuerySession | ||
Description |
This session provides methods for searching among Agencies may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getAgencySearch | ||
Description |
Gets an agency search. | ||
Return | osid.authentication.AgencySearch | an agency search | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgencySearchOrder | ||
Description |
Gets an agency search order. The | ||
Return | osid.authentication.AgencySearchOrder | the agency search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgenciesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.authentication.AgencyQuery | agencyQuery | the agency query |
osid.authentication.AgencySearch | agencySearch | the agency search | |
Return | osid.authentication.AgencySearchResults | the search results | |
Errors | NULL_ARGUMENT | agencyQuery or agencySearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | agencyQuery or agencySearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAgencyQueryFromInspector | ||
Description |
Gets an agency query from an inspector. The inspector
is available from an | ||
Parameters | osid.authentication.AgencyQueryInspector | agencyQueryInspector | an agency query inspector |
Return | osid.authentication.AgencyQuery | the agency query | |
Errors | NULL_ARGUMENT | agencyQueryInspector is null | |
UNSUPPORTED | agencyQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |