OSID - osid.authorization.rules.AuthorizationRulesManager Service Interface Definition

Interface	osid.authorization.rules.AuthorizationRulesManager
Implements	`osid.OsidManager`
Implements	`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: `AuthorizationEnablerLookupSession:` a session to retrieve authorization enablers `AuthorizationEnablerQuerySession:` a session to query for authorization enablers `AuthorizationEnablerSearchSession:` a session to search for authorization enablers `AuthorizationEnablerAdminSession:` a session to create and delete authorization enablers `AuthorizationEnablerNotificationSession:` a session to receive notifications pertaining to authorization enabler changes `AuthorizationEnablerVaultSession:` a session to look up authorization enabler vault mappings `AuthorizationEnablerVaultAssignmentSession:` a session to manage authorization enabler to vault mappings `AuthorizationEnablerSmartVaultSession:` a session to manage dynamic vaults of authorization enablers `AuthorizationEnablerRuleLookupSession:` a session to look up authorization enabler to authorization mappings `AuthorizationEnablerRuleApplicationSession:` a session to assign authorization enablers to authorizations
Method	getAuthorizationEnablerLookupSession
Description	Gets the `OsidSession` associated with the authorization enabler lookup service.
Return	`osid.authorization.rules.AuthorizationEnablerLookupSession`		an `AuthorizationEnablerLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuthorizationEnablerLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuthorizationEnablerLookup()` is `true.`
Method	getAuthorizationEnablerLookupSessionForVault
Description	Gets the `OsidSession` associated with the authorization enabler lookup service for the given vault.
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 `OsidSession` associated with the authorization enabler query service.
Return	`osid.authorization.rules.AuthorizationEnablerQuerySession`		an `AuthorizationEnablerQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuthorizationEnablerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuthorizationEnablerQuery()` is `true.`
Method	getAuthorizationEnablerQuerySessionForVault
Description	Gets the `OsidSession` associated with the authorization enabler query service for the given vault.
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 `OsidSession` associated with the authorization enabler search service.
Return	`osid.authorization.rules.AuthorizationEnablerSearchSession`		an `AuthorizationEnablerSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuthorizationEnablerSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuthorizationEnablerSearch()` is `true.`
Method	getAuthorizationEnablerSearchSessionForVault
Description	Gets the `OsidSession` associated with the authorization enablers earch service for the given vault.
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 `OsidSession` associated with the authorization enabler administration service.
Return	`osid.authorization.rules.AuthorizationEnablerAdminSession`		an `AuthorizationEnablerAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuthorizationEnablerAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuthorizationEnablerAdmin()` is `true.`
Method	getAuthorizationEnablerAdminSessionForVault
Description	Gets the `OsidSession` associated with the authorization enabler administration service for the given vault.
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 `OsidSession` associated with the authorization enabler notification service.
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 `OsidSession` associated with the authorization enabler notification service for the given vault.
Parameters	`osid.authorization.rules.AuthorizationEnablerReceiver`	`authorizationEnablerReceiver`	the notification callback
Parameters	`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 `OsidSession` to lookup authorization enabler/vault mappings for authorization enablers.
Return	`osid.authorization.rules.AuthorizationEnablerVaultSession`		an `AuthorizationEnablerVaultSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuthorizationEnablerVault()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuthorizationEnablerVault()` is `true.`
Method	getAuthorizationEnablerVaultAssignmentSession
Description	Gets the `OsidSession` associated with assigning authorization enablers to vaults for authorization.
Return	`osid.authorization.rules.AuthorizationEnablerVaultAssignmentSession`		an `AuthorizationEnablerVaultAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuthorizationEnablerVaultAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuthorizationEnablerVaultAssignment()` is `true.`
Method	getAuthorizationEnablerSmartVaultSession
Description	Gets the `OsidSession` to manage authorization enabler smart vaults.
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 `OsidSession` associated with the authorization enabler authorization mapping lookup service.
Return	`osid.authorization.rules.AuthorizationEnablerRuleLookupSession`		an `AuthorizationEnablerRuleLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuthorizationEnablerRuleLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuthorizationEnablerRuleLookup()` is `true.`
Method	getAuthorizationEnablerRuleLookupSessionForVault
Description	Gets the `OsidSession` associated with the authorization enabler mapping lookup service for the given vault.
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 `OsidSession` associated with the authorization enabler assignment service to apply enablers to vaults.
Return	`osid.authorization.rules.AuthorizationEnablerRuleApplicationSession`		an `AuthorizationEnablerRuleApplicationSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuthorizationEnablerRuleApplication()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuthorizationEnablerRuleApplication()` is `true.`
Method	getAuthorizationEnablerRuleApplicationSessionForVault
Description	Gets the `OsidSession` associated with the authorization enabler assignment service for the given vault to apply enablers to vaults.
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`