OSID - osid.ontology.rules.OntologyRulesManager Service Interface Definition

Interface	osid.ontology.rules.OntologyRulesManager
Implements	`osid.OsidManager`
Implements	`osid.ontology.rules.OntologyRulesProfile`
Description	The ontology rules manager provides access to ontology rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `RelevancyEnablerLookupSession:` a session to retrieve relevancy enablers `RelevancyEnablerQuerySession:` a session to query for relevancy enablers `RelevancyEnablerSearchSession:` a session to search for relevancy enablers `RelevancyEnablerAdminSession:` a session to create and delete relevancy enablers `RelevancyEnablerNotificationSession:` a session to receive notifications pertaining to relevancy enabler changes `RelevancyEnablerOntologySession:` a session to look up relevancy enabler ontology mappings `RelevancyEnablerOntologyAssignmentSession:` a session to manage relevancy enabler to ontology mappings `RelevancyEnablerSmartOntologySession:` a session to manage dynamic ontologies of relevancy enablers `RelevancyEnablerRuleLookupSession:` a session to look up relevancy enabler to relevancy mappings `RelevancyEnablerRuleApplicationSession:` a session to apply relevancy enablers to relevancies
Method	getRelevancyEnablerLookupSession
Description	Gets the `OsidSession` associated with the relevancy enabler lookup service.
Return	`osid.ontology.rules.RelevancyEnablerLookupSession`		a `RelevancyEnablerLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelevancyEnablerLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerLookup()` is `true.`
Method	getRelevancyEnablerLookupSessionForOntology
Description	Gets the `OsidSession` associated with the relevancy enabler lookup service for the given ontology.
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology`
Return	`osid.ontology.rules.RelevancyEnablerLookupSession`		a `RelevancyEnablerLookupSession`
Errors	NOT_FOUND		no `Ontology` found by the given `Id`
	NULL_ARGUMENT		`ontologyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelevancyEnablerLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerLookup()` and `supportsVisibleFederation()` are `true.`
Method	getRelevancyEnablerQuerySession
Description	Gets the `OsidSession` associated with the relevancy enabler query service.
Return	`osid.ontology.rules.RelevancyEnablerQuerySession`		a `RelevancyEnablerQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelevancyEnablerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerQuery()` is `true.`
Method	getRelevancyEnablerQuerySessionForOntology
Description	Gets the `OsidSession` associated with the relevancy enabler query service for the given ontology.
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology`
Return	`osid.ontology.rules.RelevancyEnablerQuerySession`		a `RelevancyEnablerQuerySession`
Errors	NOT_FOUND		no `Ontology` found by the given `Id`
	NULL_ARGUMENT		`ontologyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelevancyEnablerQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerQuery()` and `supportsVisibleFederation()` are `true`
Method	getRelevancyEnablerSearchSession
Description	Gets the `OsidSession` associated with the relevancy enabler search service.
Return	`osid.ontology.rules.RelevancyEnablerSearchSession`		a `RelevancyEnablerSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelevancyEnablerSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerSearch()` is `true.`
Method	getRelevancyEnablerSearchSessionForOntology
Description	Gets the `OsidSession` associated with the relevancy enablers earch service for the given ontology.
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology`
Return	`osid.ontology.rules.RelevancyEnablerSearchSession`		a `RelevancyEnablerSearchSession`
Errors	NOT_FOUND		no `Ontology` found by the given `Id`
	NULL_ARGUMENT		`ontologyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelevancyEnablerSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerSearch()` and `supportsVisibleFederation()` are `true.`
Method	getRelevancyEnablerAdminSession
Description	Gets the `OsidSession` associated with the relevancy enabler administration service.
Return	`osid.ontology.rules.RelevancyEnablerAdminSession`		a `RelevancyEnablerAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelevancyEnablerAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerAdmin()` is `true.`
Method	getRelevancyEnablerAdminSessionForOntology
Description	Gets the `OsidSession` associated with the relevancy enabler administration service for the given ontology.
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology`
Return	`osid.ontology.rules.RelevancyEnablerAdminSession`		a `RelevancyEnablerAdminSession`
Errors	NOT_FOUND		no `Ontology` found by the given `Id`
	NULL_ARGUMENT		`ontologyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelevancyEnablerAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerAdmin()` and `supportsVisibleFederation()` are `true`
Method	getRelevancyEnablerNotificationSession
Description	Gets the `OsidSession` associated with the relevancy enabler notification service.
Parameters	`osid.ontology.rules.RelevancyEnablerReceiver`	`relevancyEnablerReceiver`	the notification callback
Return	`osid.ontology.rules.RelevancyEnablerNotificationSession`		a `RelevancyEnablerNotificationSession`
Errors	NULL_ARGUMENT		`relevancyEnablerReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelevancyEnablerNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerNotification()` is `true.`
Method	getRelevancyEnablerNotificationSessionForOntology
Description	Gets the `OsidSession` associated with the relevancy enabler notification service for the given ontology.
Parameters	`osid.ontology.rules.RelevancyEnablerReceiver`	`relevancyEnablerReceiver`	the notification callback
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology`
Return	`osid.ontology.rules.RelevancyEnablerNotificationSession`		a `RelevancyEnablerNotificationSession`
Errors	NOT_FOUND		no ontology found by the given `Id`
	NULL_ARGUMENT		`relevancyEnablerReceiver` or `ontologyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelevancyEnablerNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerNotification()` and `supportsVisibleFederation()` are `true.`
Method	getRelevancyEnablerOntologySession
Description	Gets the `OsidSession` to lookup relevancy enabler/ontology mappings for relevancy enablers.
Return	`osid.ontology.rules.RelevancyEnablerOntologySession`		a `RelevancyEnablerOntologySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelevancyEnablerOntology()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerOntology()` is `true.`
Method	getRelevancyEnablerOntologyAssignmentSession
Description	Gets the `OsidSession` associated with assigning relevancy enablers to ontologies for relevancy.
Return	`osid.ontology.rules.RelevancyEnablerOntologyAssignmentSession`		a `RelevancyEnablerOntologyAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelevancyEnablerOntologyAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerOntologyAssignment()` is `true.`
Method	getRelevancyEnablerSmartOntologySession
Description	Gets the `OsidSession` to manage relevancy enabler smart ontologies.
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology`
Return	`osid.ontology.rules.RelevancyEnablerSmartOntologySession`		a `RelevancyEnablerSmartOntologySession`
Errors	NOT_FOUND		no `Ontology` found by the given `Id`
	NULL_ARGUMENT		`ontologyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelevancyEnablerSmartOntology()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerSmartOntology()` is `true.`
Method	getRelevancyEnablerRuleLookupSession
Description	Gets the `OsidSession` associated with the relevancy enabler mapping lookup service.
Return	`osid.ontology.rules.RelevancyEnablerRuleLookupSession`		a `RelevancyEnablerRuleSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelevancyEnablerRuleLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerRuleLookup()` is `true.`
Method	getRelevancyEnablerRuleLookupSessionForOntology
Description	Gets the `OsidSession` associated with the relevancy enabler mapping lookup service for the given ontology.
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology`
Return	`osid.ontology.rules.RelevancyEnablerRuleLookupSession`		a `RelevancyEnablerRuleLookupSession`
Errors	NOT_FOUND		no `Ontology` found by the given `Id`
	NULL_ARGUMENT		`ontologyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelevancyEnablerRuleLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerRuleLookup()` and `supportsVisibleFederation()` are `true.`
Method	getRelevancyEnablerRuleApplicationSession
Description	Gets the `OsidSession` associated with the relevancy enabler assignment service.
Return	`osid.ontology.rules.RelevancyEnablerRuleApplicationSession`		a `RelevancyEnablerRuleApplicationSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelevancyEnablerRuleApplication()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerRuleApplication()` is `true.`
Method	getRelevancyEnablerRuleApplicationSessionForOntology
Description	Gets the `OsidSession` associated with the relevancy enabler assignment service for the given ontology.
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology`
Return	`osid.ontology.rules.RelevancyEnablerRuleApplicationSession`		a `RelevancyEnablerRuleApplicationSession`
Errors	NOT_FOUND		no `Ontology` found by the given `Id`
	NULL_ARGUMENT		`ontologyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelevancyEnablerRuleApplication()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyEnablerRuleApplication()` and `supportsVisibleFederation()` are `true.`