OSID Specifications
authentication package
Version 3.0.0
Release Candidate Preview
authentication package
Version 3.0.0
Release Candidate Preview
| Interface | osid.authentication.AgentQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
| Description |
This is the query inspector for examining agent queries. | ||
| Method | getResourceIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the resource Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceTerms | ||
| Description |
Gets the resource terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the resource terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgencyIdTerms | ||
| Description |
Gets the agency | ||
| Return | osid.search.terms.IdTerm[] | the agency Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgencyTerms | ||
| Description |
Gets the agency terms. | ||
| Return | osid.authentication.AgencyQueryInspector[] | the agency terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentQueryInspectorRecord | ||
| Description |
Gets the query inspector record corresponding to the
given | ||
| Parameters | osid.type.Type | agentRecordType | an agent record type |
| Return | osid.authentication.records.AgentQueryInspectorRecord | the agent query inspector record | |
| Errors | NULL_ARGUMENT | agentRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(agentRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |