| Interface | osid.authorization.AuthorizationManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.authorization.AuthorizationProfile | |||
| Description |
The authorization manager provides access to authorization sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
| Method | getAuthorizationSession | ||
| Description |
Gets an | ||
| Return | osid.authorization.AuthorizationSession | an authorization session for this service | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuthorization() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorization()
is true. | |
| Method | getAuthorizationSessionForVault | ||
| Description |
Gets an | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.AuthorizationSession | an AuthorizationSession | |
| Errors | NOT_FOUND | vaultId | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuthorization() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorization()
and supportsVisibleFederation() are true. | |
| Method | getAuthorizationLookupSession | ||
| Description |
Gets the | ||
| Return | osid.authorization.AuthorizationLookupSession | an AuthorizationLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuthorizationLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorizationLookup()
is true. | |
| Method | getAuthorizationLookupSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.AuthorizationLookupSession | an AuthorizationLookupSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuthorizationLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorizationLookup()
and supportsVisibleFederation() are true.
| |
| Method | getAuthorizationQuerySession | ||
| Description |
Gets the | ||
| Return | osid.authorization.AuthorizationQuerySession | an AuthorizationQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuthorizationQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorizationQuery()
is true. | |
| Method | getAuthorizationQuerySessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.AuthorizationQuerySession | an AuthorizationQuerySession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuthorizationQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorizationQuery()
and supportsVisibleFederation() are true.
| |
| Method | getAuthorizationSearchSession | ||
| Description |
Gets the | ||
| Return | osid.authorization.AuthorizationSearchSession | an AuthorizationSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuthorizationSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorizationSearch()
is true. | |
| Method | getAuthorizationSearchSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.AuthorizationSearchSession | an AuthorizationSearchSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuthorizationSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorizationSearch()
and supportsVisibleFederation() are true.
| |
| Method | getAuthorizationAdminSession | ||
| Description |
Gets the | ||
| Return | osid.authorization.AuthorizationAdminSession | an AuthorizationAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuthorizationAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorizationAdmin()
is true. | |
| Method | getAuthorizationAdminSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.AuthorizationAdminSession | an AuthorizationAdminSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuthorizationAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorizationAdmin()
and supportsVisibleFederation() are true.
| |
| Method | getAuthorizationNotificationSession | ||
| Description |
Gets the notification session for notifications pertaining to authorization changes. | ||
| Parameters | osid.authorization.AuthorizationReceiver | authorizationReceiver | the authorization receiver |
| Return | osid.authorization.AuthorizationNotificationSession | an AuthorizationNotificationSession | |
| Errors | NULL_ARGUMENT | authorizationReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuthorizationNotification() is false | ||
| Compliance | optional | This method must be implemented if
supportsAuthorizationNotification() is true. | |
| Method | getAuthorizationNotificationSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.authorization.AuthorizationReceiver | authorizationReceiver | the authorization receiver |
osid.id.Id | vaultId | the Id of the vault | |
| Return | osid.authorization.AuthorizationNotificationSession | an AuthorizationNotificationSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | authorizationReceiver or vaultId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuthorizationNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsAuthorizationNotification() and
supportsVisibleFederation() are true. | |
| Method | getAuthorizationVaultSession | ||
| Description |
Gets the session for retrieving authorization to vault mappings. | ||
| Return | osid.authorization.AuthorizationVaultSession | an AuthorizationVaultSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuthorizationVault() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorizationVault()
is true. | |
| Method | getAuthorizationVaultAssignmentSession | ||
| Description |
Gets the session for assigning authorizations to vault mappings. | ||
| Return | osid.authorization.AuthorizationVaultAssignmentSession | a AuthorizationVaultAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuthorizationVaultAssignment() is false
| ||
| Compliance | optional | This method must be implemented if
supportsAuthorizationVaultAssignment() is true. | |
| Method | getAuthorizationSmartVaultSession | ||
| Description |
Gets the session for managing dynamic authorization vaults. | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.AuthorizationSmartVaultSession | a AuthorizationSmartVaultSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuthorizationSmartVault() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorizationSmartVault()
is true. | |
| Method | getFunctionLookupSession | ||
| Description |
Gets the | ||
| Return | osid.authorization.FunctionLookupSession | a FunctionLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsFunctionLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionLookup()
is true. | |
| Method | getFunctionLookupSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.FunctionLookupSession | a FunctionLookupSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsFunctionLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionLookup()
and supportsVisibleFederation() are true. | |
| Method | getFunctionQuerySession | ||
| Description |
Gets the | ||
| Return | osid.authorization.FunctionQuerySession | a FunctionQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsFunctionQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionQuery()
is true. | |
| Method | getFunctionQuerySessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.FunctionQuerySession | a FunctionQuerySession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsFunctionQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionQuery()
and supportsVisibleFederation() are true. | |
| Method | getFunctionSearchSession | ||
| Description |
Gets the | ||
| Return | osid.authorization.FunctionSearchSession | a FunctionSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsFunctionSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionSearch()
is true. | |
| Method | getFunctionSearchSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.FunctionSearchSession | a FunctionSearchSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsFunctionSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionSearch()
and supportsVisibleFederation() are true. | |
| Method | getFunctionAdminSession | ||
| Description |
Gets the | ||
| Return | osid.authorization.FunctionAdminSession | a FunctionAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsFunctionAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionAdmin()
is true. | |
| Method | getFunctionAdminSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.FunctionAdminSession | a FunctionAdminSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsFunctionAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionAdmin()
and supportsVisibleFederation() are true. | |
| Method | getFunctionNotificationSession | ||
| Description |
Gets the notification session for notifications pertaining to function changes. | ||
| Parameters | osid.authorization.FunctionReceiver | functionReceiver | the function receiver |
| Return | osid.authorization.FunctionNotificationSession | a FunctionNotificationSession | |
| Errors | NULL_ARGUMENT | functionReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsFunctionNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionNotification()
is true. | |
| Method | getFunctionNotificationSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.authorization.FunctionReceiver | functionReceiver | the function receiver |
osid.id.Id | vaultId | the Id of the vault | |
| Return | osid.authorization.FunctionNotificationSession | a FunctionNotificationSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | functionReceiver or vaultId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsFunctionNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionNotification()
and supportsVisibleFederation() are true.
| |
| Method | getFunctionVaultSession | ||
| Description |
Gets the session for retrieving function to vault mappings. | ||
| Return | osid.authorization.FunctionVaultSession | a FunctionVaultSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsFunctionVault() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionVault()
is true. | |
| Method | getFunctionVaultAssignmentSession | ||
| Description |
Gets the session for assigning function to vault mappings. | ||
| Return | osid.authorization.FunctionVaultAssignmentSession | a FunctionVaultAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsFunctionVaultAssignment() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionVaultAssignment()
is true. | |
| Method | getFunctionSmartVaultSession | ||
| Description |
Gets the session associated with the function smart vault for the given vault. | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.FunctionSmartVaultSession | a FunctionSmartVaultSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsFunctionSmartVault() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionSmartVault()
is true. | |
| Method | getQualifierLookupSession | ||
| Description |
Gets the | ||
| Return | osid.authorization.QualifierLookupSession | a QualifierLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQualifierLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierLookup()
is true. | |
| Method | getQualifierLookupSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.QualifierLookupSession | a QualifierLookupSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQualifierLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierLookup()
and supportsVisibleFederation() are true. | |
| Method | getQualifierQuerySession | ||
| Description |
Gets the | ||
| Return | osid.authorization.QualifierQuerySession | a QualifierQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQualifierQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierQuery()
is true. | |
| Method | getQualifierQuerySessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.QualifierQuerySession | a QualifierQuerySession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQualifierQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierQuery()
and supportsVisibleFederation() are true. | |
| Method | getQualifierSearchSession | ||
| Description |
Gets the | ||
| Return | osid.authorization.QualifierSearchSession | a QualifierSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQualifierSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierSearch()
is true. | |
| Method | getQualifierSearchSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.QualifierSearchSession | a QualifierSearchSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQualifierSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierSearch()
and supportsVisibleFederation() are true. | |
| Method | getQualifierAdminSession | ||
| Description |
Gets the | ||
| Return | osid.authorization.QualifierAdminSession | a QualifierAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQualifierAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierAdmin()
is true. | |
| Method | getQualifierAdminSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.QualifierAdminSession | a QualifierAdminSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQualifierAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierAdmin()
and supportsVisibleFederation() are true. | |
| Method | getQualifierNotificationSession | ||
| Description |
Gets the notification session for notifications pertaining to qualifier changes. | ||
| Parameters | osid.authorization.QualifierReceiver | qualifierReceiver | the qualifier receiver |
| Return | osid.authorization.QualifierNotificationSession | a QualifierNotificationSession | |
| Errors | NULL_ARGUMENT | qualifierReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQualifierNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierNotification()
is true. | |
| Method | getQualifierNotificationSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.authorization.QualifierReceiver | qualifierReceiver | the qualifier receiver |
osid.id.Id | vaultId | the Id of the vault | |
| Return | osid.authorization.QualifierNotificationSession | a QualifierNotificationSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | qualifierReceiver or vaultId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQualifierNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierNotification()
and supportsVisibleFederation() are true.
| |
| Method | getQualifierHierarchySession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | qualifierHierarchyId | the Id of a qualifier hierarchy |
| Return | osid.authorization.QualifierHierarchySession | a QualifierHierarchySession | |
| Errors | NOT_FOUND | qualifierHierarchyId not found | |
| NULL_ARGUMENT | qualifierHierarchyId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQualifierHierarchy() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierHierarchy()
is true. | |
| Method | getQualifierHierarchyDesignSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | qualifierHierarchyId | the Id of a qualifier hierarchy |
| Return | osid.authorization.QualifierHierarchyDesignSession | a QualifierHierarchyDesignSession | |
| Errors | NOT_FOUND | qualifierHierarchyId not found | |
| NULL_ARGUMENT | qualifierHierarchyId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQualifierHierarchyDesign() is false | ||
| Compliance | optional | This method must be implemented if
supportsQualifierHierarchyDesign() is true. | |
| Method | getQualifierVaultSession | ||
| Description |
Gets the session for retrieving qualifier to vault mappings. | ||
| Return | osid.authorization.QualifierVaultSession | a QualifierVaultSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQualifierVault() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierVault()
is true. | |
| Method | getQualifierVaultAssignmentSession | ||
| Description |
Gets the session for assigning qualifier to vault mappings. | ||
| Return | osid.authorization.QualifierVaultSession | a QualifierVaultAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQualifierVaultAssignment() is false | ||
| Compliance | optional | This method must be implemented if
supportsQualifierVaultAssignment() is true. | |
| Method | getQualifierSmartVaultSession | ||
| Description |
Gets the session associated with the qualifier smart vault for the given vault. | ||
| Parameters | osid.id.Id | vaultId | the Id of the vault |
| Return | osid.authorization.QualifierSmartVaultSession | a QualifierSmartVaultSession | |
| Errors | NOT_FOUND | vaultId not found | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQualifierSmartVault() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierSmartVault()
is true. | |
| Method | getVaultLookupSession | ||
| Description |
Gets the OsidSession associated with the vault lookup service. | ||
| Return | osid.authorization.VaultLookupSession | a VaultLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsVaultLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsVaultLookup() is
true. | |
| Method | getVaultQuerySession | ||
| Description |
Gets the OsidSession associated with the vault query service. | ||
| Return | osid.authorization.VaultQuerySession | a VaultQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsVaultQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsVaultQuery() is
true. | |
| Method | getVaultSearchSession | ||
| Description |
Gets the OsidSession associated with the vault search service. | ||
| Return | osid.authorization.VaultSearchSession | a VaultSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsVaultSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsVaultSearch() is
true. | |
| Method | getVaultAdminSession | ||
| Description |
Gets the OsidSession associated with the vault administration service. | ||
| Return | osid.authorization.VaultAdminSession | a VaultAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsVaultAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsVaultAdmin() is
true. | |
| Method | getVaultNotificationSession | ||
| Description |
Gets the notification session for notifications pertaining to vault service changes. | ||
| Parameters | osid.authorization.VaultReceiver | vaultreceiver | the vault receiver |
| Return | osid.authorization.VaultNotificationSession | a VaultNotificationSession | |
| Errors | NULL_ARGUMENT | vaultReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsVaultNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsVaultNotification()
is true. | |
| Method | getVaultHierarchySession | ||
| Description |
Gets the session traversing vault hierarchies. | ||
| Return | osid.authorization.VaultHierarchySession | a VaultHierarchySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsVaultHierarchy() is false | ||
| Compliance | optional | This method must be implemented if supportsVaultHierarchy()
is true. | |
| Method | getVaultHierarchyDesignSession | ||
| Description |
Gets the session designing vault hierarchies. | ||
| Return | osid.authorization.VaultHierarchyDesignSession | a VaultHierarchyDesignSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsVaultHierarchyDesign() is false | ||
| Compliance | optional | This method must be implemented if supportsVaultHierarchyDesign()
is true. | |
| Method | getAuthorizationBatchManager | ||
| Description |
Gets an | ||
| Return | osid.authorization.batch.AuthorizationBatchManager | an AuthorizationBatchManager | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuthorizationBatch() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorizationBatch()
is true. | |
| Method | getAuthorizationRulesManager | ||
| Description |
Gets an | ||
| Return | osid.authorization.rules.AuthorizationRulesManager | an AuthorizationRulesManager | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuthorizationRules() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorizationRules()
is true. | |