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

Interface	osid.ontology.rules.RelevancyEnablerRuleLookupSession
Implements	`osid.OsidSession`
Used By	`osid.ontology.rules.OntologyRulesManager`
Used By	`osid.ontology.rules.OntologyRulesProxyManager`
Description	This session provides methods to retrieve `RelevancyEnabler` to `Relevancy` mappings. A `Relevancy` with multiple `RelevancyEnablers` means any positive rule evaluation across the enablers result in an effective `Relevancy`. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated ontology view: All methods in this session operate, retrieve and pertain relevancy enablers defined explicitly in the current ontology federated ontology view: All methods in this session operate, retrieve and pertain to all relevancy enablers defined in this ontology and any other relevancy enablers implicitly available in this ontology through ontology inheritence.
Method	getOntologyId
Description	Gets the `Ontology` `Id` associated with this session.
Return	`osid.id.Id`		the `Ontology Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOntology
Description	Gets the `Ontology` associated with this session.
Return	`osid.ontology.Ontology`		the ontology
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupRelevancyEnablerRule
Description	Tests if this user can perform lookups of relevancy enabler/relevancy mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeRelevancyEnablerRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryRelevancyEnablerRuleView
Description	A complete view of the `RelevancyEnabler` and `Relevancy` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedOntologyView
Description	Federates the view for methods in this session. A federated view will include relevancy enablers in ontologies which are children of this ontology in the ontology hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOntologyView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this ontology only.
Compliance	`mandatory`		This method is must be implemented.
Method	getRelevancyEnablerIdsForRelevancy
Description	Gets the `RelevancyEnabler Id` associated with a `Relevancy`.
Parameters	`osid.id.Id`	`relevancyId`	`Id` of the `Relevancy`
Return	`osid.id.IdList`		the relevancy enabler `Ids`
Errors	NOT_FOUND		`relevancyId` is not found
	NULL_ARGUMENT		`relevancyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyEnablersForRelevancy
Description	Gets the `RelevancyEnabler` associated with a `Relevancy`.
Parameters	`osid.id.Id`	`relevancyId`	`Id` of the `Relevancy`
Return	`osid.ontology.rules.RelevancyEnablerList`		the relevancy enablers
Errors	NOT_FOUND		`relevancyId` is not found
	NULL_ARGUMENT		`relevancyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyIdsForRelevancyEnabler
Description	Gets the `Relevancy` `Ids` mapped to a `RelevancyEnabler`.
Parameters	`osid.id.Id`	`relevancyEnablerId`	`Id` of a `RelevancyEnabler`
Return	`osid.id.IdList`		list of relevancy `Ids`
Errors	NOT_FOUND		`relevancyEnablerId` is not found
	NULL_ARGUMENT		`relevancyEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelevanciesForRelevancyEnabler
Description	Gets the `Relevancies` mapped to a `RelevancyEnabler`.
Parameters	`osid.id.Id`	`relevancyEnablerId`	`Id` of a `RelevancyEnabler`
Return	`osid.ontology.RelevancyList`		list of relevancies
Errors	NOT_FOUND		`relevancyEnablerId` is not found
	NULL_ARGUMENT		`relevancyEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.