OSID - osid.repository.rules.RepositoryRulesManager Service Interface Definition

Interface	osid.repository.rules.RepositoryRulesManager
Implements	`osid.OsidManager`
Implements	`osid.repository.rules.RepositoryRulesProfile`
Description	The repository rules manager provides access to repository rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `CompositionEnablerLookupSession:` a session to retrieve composition enablers `CompositionEnablerQuerySession:` a session to query for composition enablers `CompositionEnablerSearchSession:` a session to search for composition enablers `CompositionEnablerAdminSession:` a session to create and delete composition enablers `CompositionEnablerNotificationSession:` a session to receive notifications pertaining to composition enabler changes `CompositionEnablerRepositorySession:` a session to look up composition enabler repository mappings `CompositionEnablerRepositoryAssignmentSession:` a session to manage composition enabler to repository mappings `CompositionEnablerSmartRepositorySession:` a session to manage dynamic repositories of composition enablers `CompositionEnablerRuleLookupSession:` a session to look up composition enabler to composition mappings `CompositionEnablerRuleApplicationSession:` a session to apply composition enablers to compositions
Method	getCompositionEnablerLookupSession
Description	Gets the `OsidSession` associated with the composition enabler lookup service.
Return	`osid.repository.rules.CompositionEnablerLookupSession`		a `CompositionEnablerLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCompositionEnablerLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerLookup()` is `true.`
Method	getCompositionEnablerLookupSessionForRepository
Description	Gets the `OsidSession` associated with the composition enabler lookup service for the given repository.
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the `Repository`
Return	`osid.repository.rules.CompositionEnablerLookupSession`		a `CompositionEnablerLookupSession`
Errors	NOT_FOUND		no `Repository` found by the given `Id`
	NULL_ARGUMENT		`repositoryId is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCompositionEnablerLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerLookup()` and `supportsVisibleFederation()` are `true.`
Method	getCompositionEnablerQuerySession
Description	Gets the `OsidSession` associated with the composition enabler query service.
Return	`osid.repository.rules.CompositionEnablerQuerySession`		a `CompositionEnablerQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCompositionEnablerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerQuery()` is `true.`
Method	getCompositionEnablerQuerySessionForRepository
Description	Gets the `OsidSession` associated with the composition enabler query service for the given repository.
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the `Repository`
Return	`osid.repository.rules.CompositionEnablerQuerySession`		a `CompositionEnablerQuerySession`
Errors	NOT_FOUND		no `Repository` found by the given `Id`
	NULL_ARGUMENT		`repositoryId is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCompositionEnablerQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerQuery()` and `supportsVisibleFederation()` are `true.`
Method	getCompositionEnablerSearchSession
Description	Gets the `OsidSession` associated with the composition enabler search service.
Return	`osid.repository.rules.CompositionEnablerSearchSession`		a `CompositionEnablerSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCompositionEnablerSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerSearch()` is `true.`
Method	getCompositionEnablerSearchSessionForRepository
Description	Gets the `OsidSession` associated with the composition enablers earch service for the given repository.
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the `Repository`
Return	`osid.repository.rules.CompositionEnablerSearchSession`		a `CompositionEnablerSearchSession`
Errors	NOT_FOUND		no `Repository` found by the given `Id`
	NULL_ARGUMENT		`repositoryId is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCompositionEnablerSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerSearch()` and `supportsVisibleFederation()` are `true.`
Method	getCompositionEnablerAdminSession
Description	Gets the `OsidSession` associated with the composition enabler administration service.
Return	`osid.repository.rules.CompositionEnablerAdminSession`		a `CompositionEnablerAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCompositionEnablerAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerAdmin()` is `true.`
Method	getCompositionEnablerAdminSessionForRepository
Description	Gets the `OsidSession` associated with the composition enabler administration service for the given repository.
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the `Repository`
Return	`osid.repository.rules.CompositionEnablerAdminSession`		a `CompositionEnablerAdminSession`
Errors	NOT_FOUND		no `Repository` found by the given `Id`
	NULL_ARGUMENT		`repositoryId is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCompositionEnablerAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getCompositionEnablerNotificationSession
Description	Gets the `OsidSession` associated with the composition enabler notification service.
Parameters	`osid.repository.rules.CompositionEnablerReceiver`	`compositionEnablerReceiver`	the notification callback
Return	`osid.repository.rules.CompositionEnablerNotificationSession`		a `CompositionEnablerNotificationSession`
Errors	NULL_ARGUMENT		`compositionEnablerReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCompositionEnablerNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerNotification()` is `true.`
Method	getCompositionEnablerNotificationSessionForRepository
Description	Gets the `OsidSession` associated with the composition enabler notification service for the given repository.
Parameters	`osid.repository.rules.CompositionEnablerReceiver`	`compositionEnablerReceiver`	the notification callback
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the `Repository`
Return	`osid.repository.rules.CompositionEnablerNotificationSession`		a `CompositionEnablerNotificationSession`
Errors	NOT_FOUND		no repository found by the given `Id`
	NULL_ARGUMENT		`compositionEnablerReceiver` or `repositoryId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCompositionEnablerNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerNotification()` and `supportsVisibleFederation()` are `true.`
Method	getCompositionEnablerRepositorySession
Description	Gets the `OsidSession` to lookup composition enabler repository mappings for composition enablers.
Return	`osid.repository.rules.CompositionEnablerRepositorySession`		a `CompositionEnablerCompositionSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCompositionEnablerRepository()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerRepository()` is `true.`
Method	getCompositionEnablerRepositoryAssignmentSession
Description	Gets the `OsidSession` associated with assigning composition enablers to repositories.
Return	`osid.repository.rules.CompositionEnablerRepositoryAssignmentSession`		a `CompositionEnablerRepositoryAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCompositionEnablerCompositionAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerRepositoryAssignment()` is `true.`
Method	getCompositionEnablerSmartRepositorySession
Description	Gets the `OsidSession` to manage composition enabler smart repositories.
Parameters	`osid.id.Id`	`repositoryId`	the Id of the `Repository`
Return	`osid.repository.rules.CompositionEnablerSmartRepositorySession`		a `CompositionEnablerSmartRepositorySession`
Errors	NOT_FOUND		no `Repository` found by the given `Id`
	NULL_ARGUMENT		`repositoryId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCompositionEnablerSmartRepository()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerSmartRepository()` is `true.`
Method	getCompositionEnablerRuleLookupSession
Description	Gets the `OsidSession` associated with the composition enabler mapping lookup service for looking up the rules applied to a composition.
Return	`osid.repository.rules.CompositionEnablerRuleLookupSession`		a `CompositionEnablerRuleLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCompositionEnablerRuleLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerRuleLookup()` is `true.`
Method	getCompositionEnablerRuleLookupSessionForRepository
Description	Gets the `OsidSession` associated with the composition enabler mapping lookup service for the given composition for looking up rules applied to a composition.
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the `Repository`
Return	`osid.repository.rules.CompositionEnablerRuleLookupSession`		a `CompositionEnablerRuleLookupSession`
Errors	NOT_FOUND		no `Repository` found by the given `Id`
	NULL_ARGUMENT		`repositoryId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCompositionEnablerRuleLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerRuleLookup()` and `supportsVisibleFederation()` are `true.`
Method	getCompositionEnablerRuleApplicationSession
Description	Gets the `OsidSession` associated with the composition enabler assignment service to apply enablers to compositions.
Return	`osid.repository.rules.CompositionEnablerRuleApplicationSession`		a `CompositionEnablerRuleApplicationSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCompositionEnablerRuleApplication()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerRuleApplication()` is `true.`
Method	getCompositionEnablerRuleApplicationSessionForRepository
Description	Gets the `OsidSession` associated with the composition enabler assignment service for the given composition to apply enablers to compositions.
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the `Repository`
Return	`osid.repository.rules.CompositionEnablerRuleApplicationSession`		a `CompositionEnablerRuleApplicationSession`
Errors	NOT_FOUND		no `Repository` found by the given `Id`
	NULL_ARGUMENT		`repositoryId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCompositionEnablerRuleApplication()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionEnablerRuleApplication()` and `supportsVisibleFederation()` are `true.`