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

Interface	osid.ontology.rules.RelevancyEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.ontology.rules.OntologyRulesManager`
Used By	`osid.ontology.rules.OntologyRulesProxyManager`
Description	This session provides methods to apply `RelevancyEnablers` to `Relevancies` . A `Relevancy` with multiple `RelevancyEnablers` means any positive rule evaluation across the enablers result in an effective `Relevancy` .
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	canAssignRelevancyEnablers
Description	Tests if this user can alter relevancy enabler/relevancy mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	assignRelevancyEnablerToRelevancy
Description	Adds an existing `RelevancyEnabler` to a `Relevancy` .
Parameters	`osid.id.Id`	`relevancyEnablerId`	the `Id` of the `RelevancyEnabler`
Parameters	`osid.id.Id`	`relevancyId`	the `Id` of the `Relevancy`
Errors	ALREADY_EXISTS		`relevancyEnablerId` is already applied to `relevancyId`
	NOT_FOUND		`relevancyEnablerId` or `relevancyId` not found
	NULL_ARGUMENT		`relevancyEnablerId` or `relevancyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignRelevancyEnablerFromRelevancy
Description	Removes a `RelevancyEnabler` from a `Relevancy` .
Parameters	`osid.id.Id`	`relevancyEnablerId`	the `Id` of the `RelevancyEnabler`
Parameters	`osid.id.Id`	`relevancyId`	the `Id` of the `Relevancy`
Errors	NOT_FOUND		`relevancyEnablerId` or `relevancyId` not found or `relevancyEnablerId` not applied to `relevancyId`
	NULL_ARGUMENT		`relevancyEnablerId` or `relevancyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceRelevancyEnablers
Description	Tests if this user can order `RelevancyEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED` . This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `RelevancyEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveRelevancyEnablerAhead
Description	Reorders relevancy enablers for a relevancy by moving the specified relevancy enabler in front of a reference relevancy enabler.
Parameters	`osid.id.Id`	`relevancyEnablerId`	the `Id` of a `RelevancyEnabler`
	`osid.id.Id`	`relevancyId`	the `Id` of a `Relevancy`
	`osid.id.Id`	`referenceId`	the reference relevancy enabler `Id`
Errors	NOT_FOUND		`relevancyEnablerId, relevancyId` , or `referenceId` not found or, `relevancyEnablerId` or `referenceId` not related to `relevancyId`
	NULL_ARGUMENT		`relevancyEnablerId, relevancyId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveRelevancyEnablerBehind
Description	Reorders relevancy enablers for a relevancy by moving the specified relevancy enabler behind a reference relevancy enabler.
Parameters	`osid.id.Id`	`relevancyEnablerId`	the `Id` of a `RelevancyEnabler`
	`osid.id.Id`	`relevancyId`	the `Id` of a `Relevancy`
	`osid.id.Id`	`referenceId`	the reference relevancy enabler `Id`
Errors	NOT_FOUND		`relevancyEnablerId, relevancyId` , or `referenceId` not found or, `relevancyEnablerId` or `referenceId` not related to `relevancyId`
	NULL_ARGUMENT		`relevancyEnablerId, relevancyId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderRelevancyEnablers
Description	Reorders a set of relevancy enablers for a relevancy.
Parameters	`osid.id.Id[]`	`relevancyEnablerIds`	the `Ids` for a set of `RelevancyEnablers`
Parameters	`osid.id.Id`	`relevancyId`	the `Id` of a `Relevancy`
Errors	NOT_FOUND		`relevancyId` not found or, a `relevancyEnablerId` not related to `relevancyId`
	NULL_ARGUMENT		`relevancyEnablerIds` or `relevancyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.