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

Interface	osid.ontology.rules.RelevancyEnablerAdminSession
Implements	`osid.OsidSession`
Description	This session creates and removes relevancy enablers. The data for create and update is provided via the `RelevancyEnablerForm.`
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	canCreateRelevancyEnabler
Description	Tests if this user can create relevancy enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `RelevancyEnabler` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `RelevancyEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRelevancyEnablerWithRecordTypes
Description	Tests if this user can create a single `RelevancyEnabler` using the desired record types. While `OntologyRulesManager.getRelevancyEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `RelevancyEnabler.` Providing an empty array tests if a `RelevancyEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`relevancyEnablerRecordTypes`	array of relevancy enabler record types
Return	`boolean`		`true` if `RelevancyEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`relevancyEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyEnablerFormForCreate
Description	Gets the relevancy enabler form for creating new relevancy enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`relevancyEnablerRecordTypes`	array of relevancy enabler record types
Return	`osid.ontology.rules.RelevancyEnablerForm`		the relevancy enabler form
Errors	NULL_ARGUMENT		`relevancyEnablerRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createRelevancyEnabler
Description	Creates a new `RelevancyEnabler.`
Parameters	`osid.ontology.rules.RelevancyEnablerForm`	`relevancyEnablerForm`	the form for this `RelevancyEnabler`
Return	`osid.ontology.rules.RelevancyEnabler`		the new `RelevancyEnabler`
Errors	ILLEGAL_STATE		`relevancyEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`relevancyEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`relevancyEnablerForm` did not originate from `getRelevancyEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRelevancyEnablers
Description	Tests if this user can update relevancy enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `RelevancyEnabler` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `RelevancyEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyEnablerFormForUpdate
Description	Gets the relevancy enabler form for updating an existing relevancy enabler. A new relevancy enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`relevancyEnablerId`	the `Id` of the `RelevancyEnabler`
Return	`osid.ontology.rules.RelevancyEnablerForm`		the relevancy enabler form
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	updateRelevancyEnabler
Description	Updates an existing relevancy enabler.
Parameters	`osid.ontology.rules.RelevancyEnablerForm`	`relevancyEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`relevancyEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`relevancyEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`relevancyEnablerForm` did not originate from `getRelevancyEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRelevancyEnablers
Description	Tests if this user can delete relevancy enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `RelevancyEnabler` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `RelevancyEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRelevancyEnabler
Description	Deletes a `RelevancyEnabler.`
Parameters	`osid.id.Id`	`relevancyEnablerId`	the `Id` of the `RelevancyEnabler` to remove
Errors	NOT_FOUND		`relevancyEnablerId` 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	canManageRelevancyEnablerAliases
Description	Tests if this user can manage `Id` aliases for relevancy enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `RelevancyEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRelevancyEnabler
Description	Adds an `Id` to a `RelevancyEnabler` for the purpose of creating compatibility. The primary `Id` of the `RelevancyEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another relevancy enabler. it is reassigned to the given relevancy enabler `Id.`
Parameters	`osid.id.Id`	`relevancyEnablerId`	the `Id` of a `RelevancyEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`relevancyEnablerId` not found
	NULL_ARGUMENT		`relevancyEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.