OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.VaultQuery
Implementsosid.OsidCatalogQuery
Description

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

MethodmatchFunctionId
Description

Sets the function Id for this query.

Parametersosid.id.IdfunctionIda function Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT functionId is null
CompliancemandatoryThis method must be implemented.
MethodclearFunctionIdTerms
Description

Clears the function Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsFunctionQuery
Description

Tests if a FunctionQuery is available.

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

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

Returnosid.authorization.FunctionQuerythe function query
ErrorsUNIMPLEMENTED supportsFunctionQuery() is false
ComplianceoptionalThis method must be implemented if supportsFunctionQuery() is true.
MethodmatchAnyFunction
Description

Matches vaults that have any function.

Parametersbooleanmatch true to match vaults with any function mapping, false to match vaults with no function mapping
CompliancemandatoryThis method must be implemented.
MethodclearFunctionTerms
Description

Clears the function query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchQualifierId
Description

Sets the qualifier Id for this query.

Parametersosid.id.IdqualifierIda qualifier Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT qualifierId is null
CompliancemandatoryThis method must be implemented.
MethodclearQualifierIdTerms
Description

Clears the qualifier Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsQualifierQuery
Description

Tests if a QualifierQuery is available.

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

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

Returnosid.authorization.QualifierQuerythe qualifier query
ErrorsUNIMPLEMENTED supportsQualifierQuery() is false
ComplianceoptionalThis method must be implemented if supportsQualifierQuery() is true.
MethodmatchAnyQualifier
Description

Matches vaults that have any qualifier.

Parametersbooleanmatch true to match vaults with any qualifier mapping, false to match vaults with no qualifier mapping
CompliancemandatoryThis method must be implemented.
MethodclearQualifierTerms
Description

Clears the qualifier 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 vaults that have any authorization.

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

Clears the authorization query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorVaultId
Description

Sets the vault Id for this query to match vaults that have the specified vault as an ancestor.

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.
MethodclearAncestorVaultIdTerms
Description

Clears the ancestor vault Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorVaultQuery
Description

Tests if a VaultQuery is available.

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

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

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

Matches vaults that have any ancestor.

Parametersbooleanmatch true to match vaults with any ancestor, false to match root vaults
CompliancemandatoryThis method must be implemented.
MethodclearAncestorVaultTerms
Description

Clears the ancestor vault query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantVaultId
Description

Sets the vault Id for this query to match vaults that have the specified vault as a descendant.

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

Clears the descendant vault Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantVaultQuery
Description

Tests if a VaultQuery is available.

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

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

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

Matches vaults that have any descendant.

Parametersbooleanmatch true to match vaults with any Ddscendant, false to match leaf vaults
CompliancemandatoryThis method must be implemented.
MethodclearDescendantVaultTerms
Description

Clears the descendant vault query terms.

CompliancemandatoryThis method must be implemented.
MethodgetVaultQueryRecord
Description

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

Parametersosid.type.TypevaultRecordTypea vault record type
Returnosid.authorization.records.VaultQueryRecordthe vault query record
ErrorsNULL_ARGUMENT vaultRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(vaultRecordType) is false
CompliancemandatoryThis method must be implemented.