OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
authorization package
Version 3.0.0
Release Candidate Preview
| Interface | osid.authorization.AuthorizationQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Description |
The query inspector for examining authorization queries. | ||
| Method | getExplicitAuthorizationsTerms | ||
| Description |
Gets the explicit authorization query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelatedAuthorizationIdTerms | ||
| Description |
Gets the related authorization | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelatedAuthorizationTerms | ||
| Description |
Gets the related authorization query terms. | ||
| Return | osid.authorization.AuthorizationQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceTerms | ||
| Description |
Gets the resource query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTrustIdTerms | ||
| Description |
Gets the trust | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentIdTerms | ||
| Description |
Gets the agent | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentTerms | ||
| Description |
Gets the agent query terms. | ||
| Return | osid.authentication.AgentQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| 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 | 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 | getAuthorizationQueryInspectorRecord | ||
| Description |
Gets the authorization query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | authorizationRecordType | an authorization record type |
| Return | osid.authorization.records.AuthorizationQueryInspectorRecord | the authorization query inspector record | |
| Errors | NULL_ARGUMENT | authorizationRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(authorizationRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |