Interface | osid.authorization.rules.AuthorizationRulesManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.authorization.rules.AuthorizationRulesProfile | |||
Description |
The authorization rules manager provides access to authorization rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getAuthorizationEnablerLookupSession | ||
Description |
Gets the | ||
Return | osid.authorization.rules.AuthorizationEnablerLookupSession | an AuthorizationEnablerLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAuthorizationEnablerLookup() is false | ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerLookup() is true. | |
Method | getAuthorizationEnablerLookupSessionForVault | ||
Description |
Gets the | ||
Parameters | osid.id.Id | vaultId | the Id of the Vault |
Return | osid.authorization.rules.AuthorizationEnablerLookupSession | an AuthorizationEnablerLookupSession | |
Errors | NOT_FOUND | no Vault found by the given Id | |
NULL_ARGUMENT | vaultId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAuthorizationEnablerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerLookup() and
supportsVisibleFederation() are true. | |
Method | getAuthorizationEnablerQuerySession | ||
Description |
Gets the | ||
Return | osid.authorization.rules.AuthorizationEnablerQuerySession | an AuthorizationEnablerQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAuthorizationEnablerQuery() is false | ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerQuery() is true. | |
Method | getAuthorizationEnablerQuerySessionForVault | ||
Description |
Gets the | ||
Parameters | osid.id.Id | vaultId | the Id of the Vault |
Return | osid.authorization.rules.AuthorizationEnablerQuerySession | an AuthorizationEnablerQuerySession | |
Errors | NOT_FOUND | no Vault found by the given Id | |
NULL_ARGUMENT | vaultId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAuthorizationEnablerQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerQuery() and
supportsVisibleFederation() are true. | |
Method | getAuthorizationEnablerSearchSession | ||
Description |
Gets the | ||
Return | osid.authorization.rules.AuthorizationEnablerSearchSession | an AuthorizationEnablerSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAuthorizationEnablerSearch() is false | ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerSearch() is true. | |
Method | getAuthorizationEnablerSearchSessionForVault | ||
Description |
Gets the | ||
Parameters | osid.id.Id | vaultId | the Id of the Vault |
Return | osid.authorization.rules.AuthorizationEnablerSearchSession | an AuthorizationEnablerSearchSession | |
Errors | NOT_FOUND | no Vault found by the given Id | |
NULL_ARGUMENT | vaultId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAuthorizationEnablerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerSearch() and
supportsVisibleFederation() are true. | |
Method | getAuthorizationEnablerAdminSession | ||
Description |
Gets the | ||
Return | osid.authorization.rules.AuthorizationEnablerAdminSession | an AuthorizationEnablerAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAuthorizationEnablerAdmin() is false | ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerAdmin() is true. | |
Method | getAuthorizationEnablerAdminSessionForVault | ||
Description |
Gets the | ||
Parameters | osid.id.Id | vaultId | the Id of the Vault |
Return | osid.authorization.rules.AuthorizationEnablerAdminSession | an AuthorizationEnablerAdminSession | |
Errors | NOT_FOUND | no Vault found by the given Id | |
NULL_ARGUMENT | vaultId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAuthorizationEnablerAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerAdmin() and
supportsVisibleFederation() are true. | |
Method | getAuthorizationEnablerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.authorization.rules.AuthorizationEnablerReceiver | authorizationEnablerReceiver | the notification callback |
Return | osid.authorization.rules.AuthorizationEnablerNotificationSession | an AuthorizationEnablerNotificationSession | |
Errors | NULL_ARGUMENT | authorizationEnablerReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAuthorizationEnablerNotification() is false
| ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerNotification() is true. | |
Method | getAuthorizationEnablerNotificationSessionForVault | ||
Description |
Gets the | ||
Parameters | osid.authorization.rules.AuthorizationEnablerReceiver | authorizationEnablerReceiver | the notification callback |
osid.id.Id | vaultId | the Id of the Vault | |
Return | osid.authorization.rules.AuthorizationEnablerNotificationSession | an AuthorizationEnablerNotificationSession | |
Errors | NOT_FOUND | no vault found by the given Id | |
NULL_ARGUMENT | authorizationEnablerReceiver or vaultId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAuthorizationEnablerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerNotification() and
supportsVisibleFederation() are true. | |
Method | getAuthorizationEnablerVaultSession | ||
Description |
Gets the | ||
Return | osid.authorization.rules.AuthorizationEnablerVaultSession | an AuthorizationEnablerVaultSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAuthorizationEnablerVault() is false | ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerVault() is true. | |
Method | getAuthorizationEnablerVaultAssignmentSession | ||
Description |
Gets the | ||
Return | osid.authorization.rules.AuthorizationEnablerVaultAssignmentSession | an AuthorizationEnablerVaultAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAuthorizationEnablerVaultAssignment() is
false | ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerVaultAssignment() is true. | |
Method | getAuthorizationEnablerSmartVaultSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | vaultId | the Id of the Vault |
Return | osid.authorization.rules.AuthorizationEnablerSmartVaultSession | an AuthorizationEnablerSmartVaultSession | |
Errors | NOT_FOUND | no Vault found by the given Id | |
NULL_ARGUMENT | vaultId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAuthorizationEnablerSmartVault() is false
| ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerSmartVault() is true. | |
Method | getAuthorizationEnablerRuleLookupSession | ||
Description |
Gets the | ||
Return | osid.authorization.rules.AuthorizationEnablerRuleLookupSession | an AuthorizationEnablerRuleLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAuthorizationEnablerRuleLookup() is false
| ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerRuleLookup() is true. | |
Method | getAuthorizationEnablerRuleLookupSessionForVault | ||
Description |
Gets the | ||
Parameters | osid.id.Id | vaultId | the Id of the Vault |
Return | osid.authorization.rules.AuthorizationEnablerRuleLookupSession | an AuthorizationEnablerRuleLookupSession | |
Errors | NOT_FOUND | no Vault found by the given Id | |
NULL_ARGUMENT | vaultId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAuthorizationEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerRuleLookup() and
supportsVisibleFederation() are true. | |
Method | getAuthorizationEnablerRuleApplicationSession | ||
Description |
Gets the | ||
Return | osid.authorization.rules.AuthorizationEnablerRuleApplicationSession | an AuthorizationEnablerRuleApplicationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAuthorizationEnablerRuleApplication() is
false | ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerRuleApplication() is true. | |
Method | getAuthorizationEnablerRuleApplicationSessionForVault | ||
Description |
Gets the | ||
Parameters | osid.id.Id | vaultId | the Id of the Vault |
Return | osid.authorization.rules.AuthorizationEnablerRuleApplicationSession | an AuthorizationEnablerRuleApplicationSession | |
Errors | NOT_FOUND | no Vault found by the given Id | |
NULL_ARGUMENT | vaultId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAuthorizationEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsAuthorizationEnablerRuleApplication() and
supportsVisibleFederation() are true |