Interface | osid.authorization.AuthorizationSmartVaultSession | ||
---|---|---|---|
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 | canManageSmartVault | ||
Description |
Tests if this user can manage smart vault. 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 | getAuthorizationQuery | ||
Description |
Gets a authorization query. | ||
Return | osid.authorization.AuthorizationQuery | the authorization query | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationSearchOrder | ||
Description |
Gets a authorization search order. | ||
Return | osid.authorization.AuthorizationSearchOrder | the authorization search order. | |
Compliance | mandatory | This method must be implemented. | |
Method | applyAuthorizationQuery | ||
Description |
Applies a authorization query to this vault. | ||
Parameters | osid.authorization.AuthorizationQuery | authorizationQuery | the authorization query |
Errors | NULL_ARGUMENT | authorizationQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | authorizationQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectAuthorizationQuery | ||
Description |
Gets a authorization query inspector for this vault. | ||
Return | osid.authorization.AuthorizationQueryInspector | the authorization query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyAuthorizationSequencing | ||
Description |
Applies a authorization search order to this vault. | ||
Parameters | osid.authorization.AuthorizationSearchOrder | authorizationSearchOrder | the authorization search order |
Errors | NULL_ARGUMENT | authorizationSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | authorizationSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationQueryFromInspector | ||
Description |
Gets a authorization query from an inspector. | ||
Parameters | osid.authorization.AuthorizationQueryInspector | authorizationQueryInspector | a resorce relationship query inspector |
Return | osid.authorization.AuthorizationQuery | the authorization query | |
Errors | NULL_ARGUMENT | authorizationQueryInspector is null | |
UNSUPPORTED | authorizationQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |