OSID - osid.ontology.RelevancyAdminSession Service Interface Definition

Interface	osid.ontology.RelevancyAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.ontology.batch.RelevancyBatchAdminSession`
Used By	`osid.ontology.OntologyManager`
Used By	`osid.ontology.OntologyProxyManager`
Description	This session creates, updates, and deletes `Relevancies`. The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Relevancy`, a `RelevancyForm` is requested using `getRelevancyFormForCreate()` specifying the desired peers and record `Types` or none if no record `Types` are needed. The returned `RelevancyForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `RelevancyForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RelevancyForm` corresponds to an attempted transaction. For updates, `RelevancyForms` are requested to the `Relevancy` `Id` that is to be updated using `getRelevancyFormForUpdate()`. Similarly, the `RelevancyForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `RelevancyForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Relevancies`. To unmap a `Relevancy` from the current `Ontology`, the `RelevancyOntologyAssignmentSession` should be used. These delete operations attempt to remove the `Relevancy` itself thus removing it from all known `Ontology` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRelevancies
Description	Tests if this user can create relevancies. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Relevancy` 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 `Relevancy` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRelevancyWithRecordTypes
Description	Tests if this user can create a single `Relevancy` using the desired record interface types. While `OntologyManager.getRelevancyRecordTypes()` can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific `Relevancy`. Providing an empty array tests if a `Relevancy` can be created with no records.
Parameters	`osid.type.Type[]`	`relevancyRecordTypes`	array of relevancy record types
Return	`boolean`		`true` if `Relevancy` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`relevancyRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyFormForCreate
Description	Gets the relevancy form for creating new relevancies. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`subjectId`	the `Id` of the `Subject`
	`osid.id.Id`	`id`	a mapped `Id`
	`osid.type.Type[]`	`relevancyRecordTypes`	array of relevancy record types
Return	`osid.ontology.RelevancyForm`		the relevancy form
Errors	NOT_FOUND		`subjectId` is not found
	NULL_ARGUMENT		`subjectId` or `id` 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	createRelevancy
Description	Creates a new `Relevancy`.
Parameters	`osid.ontology.RelevancyForm`	`relevancyForm`	the form for this `Relevancy`
Return	`osid.ontology.Relevancy`		the new `Relevancy`
Errors	ILLEGAL_STATE		`relevancyForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`relevancyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`relevancyForm` did not originate from `getRelevancyFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRelevancies
Description	Tests if this user can update relevancies. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Relevancy` 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 relevancy modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyFormForUpdate
Description	Gets the relevancy form for updating an existing relevancy. A new relevancy form should be requested for each update transaction.
Parameters	`osid.id.Id`	`relevancyId`	the `Id` of the `Relevancy`
Return	`osid.ontology.RelevancyForm`		the relevancy form
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	updateRelevancy
Description	Updates an existing relevancy.
Parameters	`osid.ontology.RelevancyForm`	`relevancyForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`relevancyForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`relevancyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`relevancyForm` did not originate from `getRelevancyFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRelevancies
Description	Tests if this user can delete relevancies. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Relevancy` 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 `Relevancy` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRelevancy
Description	Deletes the `Relevancy` identified by the given `Id`.
Parameters	`osid.id.Id`	`relevancyId`	the `Id` of the `Relevancy` to delete
Errors	NOT_FOUND		a `Relevancy` was not found identified by the given `Id`
	NULL_ARGUMENT		`relevancyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRelevancyAliases
Description	Tests if this user can manage `Id` aliases for relevancies. 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 `Relevancy` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRelevancy
Description	Adds an `Id` to a `Relevancy` for the purpose of creating compatibility. The primary `Id` of the `Relevancy` 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, it is reassigned to the given relevancy `Id`.
Parameters	`osid.id.Id`	`relevancyId`	the `Id` of a `Relevancy`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`relevancyId` not found
	NULL_ARGUMENT		`relevancyId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.