Interface OntologyAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

OntologyBatchAdminSession

public interface OntologyAdminSession
extends OsidSession

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 Summary

Modifier and Type	Method	Description
void	aliasOntology(Id ontologyId, Id aliasId)	Adds an Id to an Ontology for the purpose of creating compatibility.
boolean	canCreateOntologies()	Tests if this user can create Ontologies .
boolean	canCreateOntologyWithRecordTypes(Type[] ontologyRecordTypes)	Tests if this user can create a single Ontology using the desired record types.
boolean	canDeleteOntologies()	Tests if this user can delete ontologies.
boolean	canManageOntologyAliases()	Tests if this user can manage Id aliases for ontologies.
boolean	canUpdateOntologies()	Tests if this user can update Ontologies .
Ontology	createOntology(OntologyForm ontologyForm)	Creates a new Ontology .
void	deleteOntology(Id ontologyId)	Deletes an Ontology .
OntologyForm	getOntologyFormForCreate(Type[] ontologyRecordTypes)	Gets the ontology form for creating new ontologies.
OntologyForm	getOntologyFormForUpdate(Id ontologyId)	Gets the ontology form for updating an existing ontology.
void	updateOntology(OntologyForm ontologyForm)	Updates an existing ontology.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canCreateOntologies

boolean canCreateOntologies()

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.

Returns:

false if Ontology creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateOntologyWithRecordTypes

boolean canCreateOntologyWithRecordTypes(Type[] ontologyRecordTypes)

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:

ontologyRecordTypes - array of ontology record types

Returns:

true if Ontology creation using the specified Types is supported, false otherwise

Throws:

NullArgumentException - ontologyRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getOntologyFormForCreate

OntologyForm getOntologyFormForCreate(Type[] ontologyRecordTypes)
                               throws OperationFailedException,
PermissionDeniedException

Gets the ontology form for creating new ontologies. A new form should be requested for each create transaction.

Parameters:

ontologyRecordTypes - array of ontology record types

Returns:

the ontology form

Throws:

NullArgumentException - ontologyRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createOntology

Ontology createOntology(OntologyForm ontologyForm)
                 throws OperationFailedException,
PermissionDeniedException

Creates a new Ontology .

Parameters:

ontologyForm - the form for this Ontology

Returns:

the new Ontology

Throws:

IllegalStateException - ontologyForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - ontologyForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - ontologyForm did not originate from getOntologyFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateOntologies

boolean canUpdateOntologies()

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.

Returns:

false if Ontology modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getOntologyFormForUpdate

OntologyForm getOntologyFormForUpdate(Id ontologyId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the ontology form for updating an existing ontology. A new ontology form should be requested for each update transaction.

Parameters:

ontologyId - the Id of the Ontology

Returns:

the ontology form

Throws:

NotFoundException - ontologyId is not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateOntology

void updateOntology(OntologyForm ontologyForm)
             throws OperationFailedException,
PermissionDeniedException

Updates an existing ontology.

Parameters:

ontologyForm - the form containing the elements to be updated

Throws:

IllegalStateException - ontologyForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - ontologyForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - ontologyForm did not originate from getOntologyFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteOntologies

boolean canDeleteOntologies()

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.

Returns:

false if Ontology deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteOntology

void deleteOntology(Id ontologyId)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes an Ontology .

Parameters:

ontologyId - the Id of the Ontology to remove

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageOntologyAliases

boolean canManageOntologyAliases()

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.

Returns:

false if Ontology aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasOntology

void aliasOntology(Id ontologyId,
 Id aliasId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

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:

ontologyId - the Id of an Ontology

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - ontologyId not found

NullArgumentException - ontologyId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.