OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
authorization package
Version 3.0.0
Release Candidate Preview
| Interface | osid.authorization.VaultQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining vault queries. | ||
| Method | getFunctionIdTerms | ||
| Description |
Gets the function | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFunctionTerms | ||
| Description |
Gets the function query terms. | ||
| Return | osid.authorization.FunctionQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQualifierIdTerms | ||
| Description |
Gets the qualifier | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQualifierTerms | ||
| Description |
Gets the qualifier query terms. | ||
| Return | osid.authorization.QualifierQueryInspector[] | 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 | getAncestorVaultIdTerms | ||
| Description |
Gets the ancestor vault | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorVaultTerms | ||
| Description |
Gets the ancestor vault query terms. | ||
| Return | osid.authorization.VaultQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantVaultIdTerms | ||
| Description |
Gets the descendant vault | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantVaultTerms | ||
| Description |
Gets the descendant vault query terms. | ||
| Return | osid.authorization.VaultQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVaultQueryInspectorRecord | ||
| Description |
Gets the vault query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | vaultRecordType | a vault query inspector record type |
| Return | osid.authorization.records.VaultQueryInspectorRecord | the vault query inspector record | |
| Errors | NULL_ARGUMENT | vaultRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(vaultRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |