OSID Logo
OSID Specifications
authorization rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.rules.AuthorizationEnablerQueryInspector
Implementsosid.OsidEnablerQueryInspector
Description

This is the query inspector for examining authorization enabler queries.

MethodgetRuledAuthorizationIdTerms
Description

Gets the authorization Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetRuledAuthorizationTerms
Description

Gets the authorization query terms.

Returnosid.authorization.AuthorizationQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetVaultIdTerms
Description

Gets the vault Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetVaultTerms
Description

Gets the vault query terms.

Returnosid.authorization.VaultQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationEnablerQueryInspectorRecord
Description

Gets the authorization enabler query inspector record corresponding to the given AuthorizationEnabler record Type.

Parametersosid.type.TypeauthorizationEnablerRecordTypean authorization enabler record type
Returnosid.authorization.rules.records.AuthorizationEnablerQueryInspectorRecordthe authorization enabler query inspector record
ErrorsNULL_ARGUMENT authorizationEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(authorizationEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.