Interface | osid.authorization.FunctionSmartVaultSession | ||
---|---|---|---|
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 | getFunctionQuery | ||
Description |
Gets a function query. | ||
Return | osid.authorization.FunctionQuery | the function query | |
Compliance | mandatory | This method must be implemented. | |
Method | getFunctionSearchOrder | ||
Description |
Gets a function search order. | ||
Return | osid.authorization.FunctionSearchOrder | the function search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyFunctionQuery | ||
Description |
Applies a function query to this vault. | ||
Parameters | osid.authorization.FunctionQuery | functionQuery | the function query |
Errors | NULL_ARGUMENT | functionQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | functionQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectFunctionQuery | ||
Description |
Gets a function query inspector for this vault. | ||
Return | osid.authorization.FunctionQueryInspector | the function query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyFunctionSequencing | ||
Description |
Applies a function search order to this vault. | ||
Parameters | osid.authorization.FunctionSearchOrder | functionSearchOrder | the function search order |
Errors | NULL_ARGUMENT | functionSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | functionSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFunctionQueryFromInspector | ||
Description |
Gets a function query from an inspector. | ||
Parameters | osid.authorization.FunctionQueryInspector | functionQueryInspector | a function query inspector |
Return | osid.authorization.FunctionQuery | the function query | |
Errors | NULL_ARGUMENT | functionQueryInspector is null | |
UNSUPPORTED | functionQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |