Interface | osid.authorization.QualifierSmartVaultSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getVaultId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Vault Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getVault | ||
Description |
Gets the | ||
Return | osid.authorization.Vault | the Vault associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartVaults | ||
Description |
Tests if this user can manage smart vaults. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart vault management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getQualifierQuery | ||
Description |
Gets a qualifier query. | ||
Return | osid.authorization.QualifierQuery | the qualifier query | |
Compliance | mandatory | This method must be implemented. | |
Method | getQualifierSearchOrder | ||
Description |
Gets a qualifier search order. | ||
Return | osid.authorization.QualifierSearchOrder | the qualifier search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyQualifierQuery | ||
Description |
Applies a qualifier query to this vault. | ||
Parameters | osid.authorization.QualifierQuery | qualifierQuery | the qualifier query |
Errors | NULL_ARGUMENT | qualifierQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | qualifierQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectQualifierQuery | ||
Description |
Gets a qualifier query inspector for this vault. | ||
Return | osid.authorization.QualifierQueryInspector | the qualifier query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyQualifierSequencing | ||
Description |
Applies a qualifier search order to this vault. | ||
Parameters | osid.authorization.QualifierSearchOrder | qualifierSearchOrder | the qualifier search order |
Errors | NULL_ARGUMENT | qualifierSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | qualifierSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQualifierQueryFromInspector | ||
Description |
Gets a qualifier query from an inspector. | ||
Parameters | osid.authorization.QualifierQueryInspector | qualifierQueryInspector | a query inspector |
Return | osid.authorization.QualifierQuery | the qualifier query | |
Errors | NULL_ARGUMENT | qualifierQueryInspector is null | |
UNSUPPORTED | qualifierQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |