OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.FunctionQuery
Implementsosid.OsidRuleQuery
Description

This is the query for searching functions. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

MethodmatchQualifierHierarchyId
Description

Sets the qualifier hierarchy Id for this query.

Parametersosid.id.IdqualifierHierarchyIda hierarchy Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT qualifierHierarchyId is null
CompliancemandatoryThis method must be implemented.
MethodclearQualifierHierarchyIdTerms
Description

Clears the qualifier hierarchy Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsQualifierHierarchyQuery
Description

Tests if a HierarchyQuery is available.

Returnboolean true if a qualifier hierarchy query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQualifierHierarchyQuery
Description

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

Returnosid.hierarchy.HierarchyQuerythe qualifier hierarchy query
ErrorsUNIMPLEMENTED supportsQualifierHierarchyQuery() is false
ComplianceoptionalThis method must be implemented if supportsQualifierHierarchyQuery() is true.
MethodmatchAnyQualifierHierarchy
Description

Matches functions that have any qualifier hierarchy.

Parametersbooleanmatch true to match functions with any qualifier hierarchy, false to match functions with no qualifier hierarchy
CompliancemandatoryThis method must be implemented.
MethodclearQualifierHierarchyTerms
Description

Clears the qualifier hierarchy query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAuthorizationId
Description

Sets the authorization Id for this query.

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

Clears the authorization Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAuthorizationQuery
Description

Tests if an AuthorizationQuery is available.

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

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

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

Matches functions that have any authorization mapping.

Parametersbooleanmatch true to match functions with any authorization mapping, false to match functions with no authorization mapping
CompliancemandatoryThis method must be implemented.
MethodclearAuthorizationTerms
Description

Clears the authorization query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchVaultId
Description

Sets the vault Id for this query.

Parametersosid.id.IdvaultIda 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.
MethodgetFunctionQueryRecord
Description

Gets the function query record corresponding to the given Function record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypefunctionRecordTypea function record type
Returnosid.authorization.records.FunctionQueryRecordthe function query record
ErrorsNULL_ARGUMENT functionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(functionRecordType) is false
CompliancemandatoryThis method must be implemented.