OSID Logo
OSID Specifications
authorization rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.rules.AuthorizationEnablerQuery
Implementsosid.OsidEnablerQuery
Description

This is the query for searching authorization enablers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRuledAuthorizationId
Description

Matches enablers mapped to an authorization.

Parametersosid.id.IdauthorizationIdthe authorization Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT authorizationId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledAuthorizationIdTerms
Description

Clears the authorization Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledAuthorizationQuery
Description

Tests if an AuthorizationQuery is available.

Returnboolean true if an authorization query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledAuthorizationQuery
Description

Gets the query for an authorization. Multiple retrievals produce a nested OR term.

Returnosid.authorization.AuthorizationQuerythe authorization query
ErrorsUNIMPLEMENTED supportsRuledAuthorizationQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledAuthorizationQuery() is true.
MethodmatchAnyRuledAuthorization
Description

Matches enablers mapped to any authorization.

Parametersbooleanmatch true for enablers mapped to any authorization, false to match enablers mapped to no authorizations
CompliancemandatoryThis method must be implemented.
MethodclearRuledAuthorizationTerms
Description

Clears the authorization query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchVaultId
Description

Matches enablers mapped to the vault.

Parametersosid.id.IdvaultIdthe vault Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT vaultId is null
CompliancemandatoryThis method must be implemented.
MethodclearVaultIdTerms
Description

Clears the vault Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsVaultQuery
Description

Tests if a VaultQuery is available.

Returnboolean true if a vault query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetVaultQuery
Description

Gets the query for a vault. Multiple retrievals produce a nested OR term.

Returnosid.authorization.VaultQuerythe vault query
ErrorsUNIMPLEMENTED supportsVaultQuery() is false
ComplianceoptionalThis method must be implemented if supportsVaultQuery() is true.
MethodclearVaultTerms
Description

Clears the vault query terms.

CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationEnablerQueryRecord
Description

Gets the authorization enabler query record corresponding to the given AuthorizationEnabler record Type. Multiple record retrievals produce a nested OR term.

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