OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
authorization package
Version 3.0.0
Release Candidate Preview
| Interface | osid.authorization.QualifierQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidFederateableQueryInspector | |||
| Description |
This is the query inspector for examining qualifiers queries. | ||
| Method | getQualifierHierarchyIdTerms | ||
| Description |
Gets the qualifier hierarchy | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQualifierHierarchyTerms | ||
| Description |
Gets the qualifier hierarchy query terms. | ||
| Return | osid.hierarchy.HierarchyQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuthorizationIdTerms | ||
| Description |
Gets the authorization | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuthorizationTerms | ||
| Description |
Gets the authorization query terms. | ||
| Return | osid.authorization.AuthorizationQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorQualifierIdTerms | ||
| Description |
Gets the ancestor qualifier | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorQualifierTerms | ||
| Description |
Gets the ancestor qualifier query terms. | ||
| Return | osid.authorization.FunctionQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantQualifierIdTerms | ||
| Description |
Gets the descendant qualifier | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantQualifierTerms | ||
| Description |
Gets the descendant qualifier query terms. | ||
| Return | osid.authorization.FunctionQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVaultIdTerms | ||
| Description |
Gets the vault | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVaultTerms | ||
| Description |
Gets the vault query terms. | ||
| Return | osid.authorization.VaultQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQualifierQueryInspectorRecord | ||
| Description |
Gets the qualifier query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | qualifierRecordType | a qualifier query inspector record type |
| Return | osid.authorization.records.QualifierQueryInspectorRecord | the qualifier query inspector record | |
| Errors | NULL_ARGUMENT | qualifierRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(qualifierRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |