OSID Specifications
authentication keys package
Version 3.0.0
Release Candidate Preview
authentication keys package
Version 3.0.0
Release Candidate Preview
| Interface | osid.authentication.keys.KeyQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
| Description |
This is the query inspector for examining key queries. | ||
| Method | getAgentIdTerms | ||
| Description |
Gets the agent | ||
| Return | osid.search.terms.IdTerm[] | the agent Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentTerms | ||
| Description |
Gets the agent terms. | ||
| Return | osid.authentication.AgentQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getKeyQueryInspectorRecord | ||
| Description |
Gets the key query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | keyRecordType | a key record type |
| Return | osid.authentication.keys.records.KeyQueryInspectorRecord | the key query inspector record | |
| Errors | NULL_ARGUMENT | keyRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(keyRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |