OSID Specifications
authentication package
Version 3.1.0
authentication package
Version 3.1.0
| Interface | osid.authentication.AgencyQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Used By | osid.authentication.AgencyQueryInspector | ||
osid.authentication.AgencySearchResults | |||
osid.authentication.AgentQueryInspector | |||
| Description |
This is the query inspector for examining 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 | getAncestorAgencyIdTerms | ||
| Description |
Gets the ancestor agency | ||
| Return | osid.search.terms.IdTerm[] | the ancestor agency Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorAgencyTerms | ||
| Description |
Gets the ancestor agency terms. | ||
| Return | osid.authentication.AgencyQueryInspector[] | the ancestor agency terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantAgencyIdTerms | ||
| Description |
Gets the descendant agency | ||
| Return | osid.search.terms.IdTerm[] | the descendant agency Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantAgencyTerms | ||
| Description |
Gets the descendant agency terms. | ||
| Return | osid.authentication.AgencyQueryInspector[] | the descendant agency terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgencyQueryInspectorRecord | ||
| Description |
Gets the agency query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | agencyRecordType | an agency record type |
| Return | osid.authentication.records.AgencyQueryInspectorRecord | the agency query inspector record | |
| Errors | NULL_ARGUMENT | agencyRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(agencyRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |