OSID - osid.ontology.OntologyAdminSession Service Interface Definition

Interface	osid.ontology.OntologyAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Ontologies.` 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 an `Ontology,` an `OntologyForm` is requested using `getOntologyFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `OntologyForm` 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 `OntologyForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `OntologyForm` corresponds to an attempted transaction. For updates, `OntologyForms` are requested to the `Ontology` `Id` that is to be updated using `getOntologyFormForUpdate().` Similarly, the `OntologyForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `OntologyForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Ontologies.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateOntologies
Description	Tests if this user can create `Ontologies.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Ontology` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Ontology` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateOntologyWithRecordTypes
Description	Tests if this user can create a single `Ontology` using the desired record types. While `OntologyManager.getOntologyRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Ontology.` Providing an empty array tests if an `Ontology` can be created with no records.
Parameters	`osid.type.Type[]`	`ontologyRecordTypes`	array of ontology record types
Return	`boolean`		`true` if `Ontology` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`ontologyRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOntologyFormForCreate
Description	Gets the ontology form for creating new ontologies. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`ontologyRecordTypes`	array of ontology record types
Return	`osid.ontology.OntologyForm`		the ontology form
Errors	NULL_ARGUMENT		`ontologyRecordTypes` 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	createOntology
Description	Creates a new `Ontology.`
Parameters	`osid.ontology.OntologyForm`	`ontologyForm`	the form for this `Ontology`
Return	`osid.ontology.Ontology`		the new `Ontology`
Errors	ILLEGAL_STATE		`ontologyForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`ontologyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`ontologyForm` did not originate from `getOntologyFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateOntologies
Description	Tests if this user can update `Ontologies.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Ontology` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Ontology` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOntologyFormForUpdate
Description	Gets the ontology form for updating an existing ontology. A new ontology form should be requested for each update transaction.
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology`
Return	`osid.ontology.OntologyForm`		the ontology form
Errors	NOT_FOUND		`ontologyId` is not found
	NULL_ARGUMENT		`ontologyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateOntology
Description	Updates an existing ontology.
Parameters	`osid.ontology.OntologyForm`	`ontologyForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`ontologyForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`ontologyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`ontologyForm` did not originate from `getOntologyFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteOntologies
Description	Tests if this user can delete ontologies. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Ontology` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Ontology` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteOntology
Description	Deletes an `Ontology.`
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology` to remove
Errors	NOT_FOUND		`ontologyId` not found
	NULL_ARGUMENT		`ontologyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageOntologyAliases
Description	Tests if this user can manage `Id` aliases for ontologies. 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 `Ontology` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasOntology
Description	Adds an `Id` to an `Ontology` for the purpose of creating compatibility. The primary `Id` of the `Ontology` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another ontology, it is reassigned to the given ontology `Id.`
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of an `Ontology`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`ontologyId` not found
	NULL_ARGUMENT		`ontologyId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.