Interface | osid.authorization.VaultQuery | ||
---|---|---|---|
Implements | osid.OsidCatalogQuery | ||
Description |
This is the query for searching vaults. Each method
specifies an | ||
Method | matchFunctionId | ||
Description |
Sets the function | ||
Parameters | osid.id.Id | functionId | a function Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | functionId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearFunctionIdTerms | ||
Description |
Clears the function | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsFunctionQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a function query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getFunctionQuery | ||
Description |
Gets the query for a function. Multiple retrievals
produce a nested | ||
Return | osid.authorization.FunctionQuery | the function query | |
Errors | UNIMPLEMENTED | supportsFunctionQuery() is false | |
Compliance | optional | This method must be implemented if supportsFunctionQuery()
is true. | |
Method | matchAnyFunction | ||
Description |
Matches vaults that have any function. | ||
Parameters | boolean | match | true to match vaults with any function mapping, false
to match vaults with no function mapping |
Compliance | mandatory | This method must be implemented. | |
Method | clearFunctionTerms | ||
Description |
Clears the function query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchQualifierId | ||
Description |
Sets the qualifier | ||
Parameters | osid.id.Id | qualifierId | a qualifier Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | qualifierId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearQualifierIdTerms | ||
Description |
Clears the qualifier | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsQualifierQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a qualifier query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getQualifierQuery | ||
Description |
Gets the query for a qualifier. Multiple retrievals
produce a nested | ||
Return | osid.authorization.QualifierQuery | the qualifier query | |
Errors | UNIMPLEMENTED | supportsQualifierQuery() is false | |
Compliance | optional | This method must be implemented if supportsQualifierQuery()
is true. | |
Method | matchAnyQualifier | ||
Description |
Matches vaults that have any qualifier. | ||
Parameters | boolean | match | true to match vaults with any qualifier mapping,
false to match vaults with no qualifier mapping |
Compliance | mandatory | This method must be implemented. | |
Method | clearQualifierTerms | ||
Description |
Clears the qualifier query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAuthorizationId | ||
Description |
Sets the authorization | ||
Parameters | osid.id.Id | authorizationId | an authorization Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | authorizationId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAuthorizationIdTerms | ||
Description |
Clears the authorization | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAuthorizationQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an authorization query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationQuery | ||
Description |
Gets the query for an authorization. Multiple
retrievals produce a nested | ||
Return | osid.authorization.AuthorizationQuery | the authorization query | |
Errors | UNIMPLEMENTED | supportsAuthorizationQuery() is false | |
Compliance | optional | This method must be implemented if supportsAuthorizationQuery()
is true. | |
Method | matchAnyAuthorization | ||
Description |
Matches vaults that have any authorization. | ||
Parameters | boolean | match | true to match vaults with any authorization mapping,
false to match vaults with no authorization mapping |
Compliance | mandatory | This method must be implemented. | |
Method | clearAuthorizationTerms | ||
Description |
Clears the authorization query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAncestorVaultId | ||
Description |
Sets the vault | ||
Parameters | osid.id.Id | vaultId | a vault Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | vaultId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorVaultIdTerms | ||
Description |
Clears the ancestor vault | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAncestorVaultQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a vault query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorVaultQuery | ||
Description |
Gets the query for a vault. Multiple retrievals produce
a nested | ||
Return | osid.authorization.VaultQuery | the vault query | |
Errors | UNIMPLEMENTED | supportsAncestorVaultQuery() is false | |
Compliance | optional | This method must be implemented if supportsAncestorVaultQuery()
is true. | |
Method | matchAnyAncestorVault | ||
Description |
Matches vaults that have any ancestor. | ||
Parameters | boolean | match | true to match vaults with any ancestor, false
to match root vaults |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorVaultTerms | ||
Description |
Clears the ancestor vault query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDescendantVaultId | ||
Description |
Sets the vault | ||
Parameters | osid.id.Id | vaultId | a vault Id |
boolean | match | true for a positive match, false for negative
match | |
Errors | NULL_ARGUMENT | vaultId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantVaultIdTerms | ||
Description |
Clears the descendant vault | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDescendantVaultQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a vault query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantVaultQuery | ||
Description |
Gets the query for a vault. Multiple retrievals produce
a nested | ||
Return | osid.authorization.VaultQuery | the vault query | |
Errors | UNIMPLEMENTED | supportsDescendantVaultQuery() is false | |
Compliance | optional | This method must be implemented if supportsDescendantVaultQuery()
is true. | |
Method | matchAnyDescendantVault | ||
Description |
Matches vaults that have any descendant. | ||
Parameters | boolean | match | true to match vaults with any Ddscendant, false
to match leaf vaults |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantVaultTerms | ||
Description |
Clears the descendant vault query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getVaultQueryRecord | ||
Description |
Gets the vault query record corresponding to the given
| ||
Parameters | osid.type.Type | vaultRecordType | a vault record type |
Return | osid.authorization.records.VaultQueryRecord | the vault query record | |
Errors | NULL_ARGUMENT | vaultRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(vaultRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |