org.osid.ontology

Interface OntologyAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface OntologyAssignmentSession
extends OsidSession

This session provides methods to manage Id to Ontology mappings. Arbitrary Ids may be used to offer a restricted ontology to allow an arbitrary Id to be used in the SubjectLookupSession or the SubjectHierarchySession. Only one ontology can be assigned to an Id.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignOntology(Id id, Id ontologyId) Assigns an Id to an ontology.
boolean	canAssignOntologies() Tests if this user can manage of id/ontology mappings.
void	getIds(Id ontologyId) Gets a list of the Ids assigned to an ontology.
void	getOntology(Id id) Gets the ontology to which the Id is assigned.
void	unassignOntology(Id id, Id ontologyId) Unassigns an Id from an ontology.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignOntologies

boolean canAssignOntologies()

Tests if this user can manage of id/ontology mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known assignment methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may wish not to offer mapping functions to unauthorized users.

Returns:

false if managing mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignOntology

void assignOntology(Id id,
                  Id ontologyId)
                    throws NotFoundException,
                           OperationFailedException,
                           PermissionDeniedException

Assigns an Id to an ontology.

Parameters:

id - an Id

ontologyId - Id of the Ontology

Throws:

NotFoundException - ontologyId is not found

NullArgumentException - id or ontologyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignOntology

void unassignOntology(Id id,
                    Id ontologyId)
                      throws NotFoundException,
                             OperationFailedException,
                             PermissionDeniedException

Unassigns an Id from an ontology.

Parameters:

id - an Id

ontologyId - Id of the Ontology

Throws:

NotFoundException - id not assigned to ontologyId

NullArgumentException - id or ontologyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOntology

void getOntology(Id id)
                 throws NotFoundException,
                        OperationFailedException,
                        PermissionDeniedException

Gets the ontology to which the Id is assigned.

Parameters:

id - an Id

Throws:

NotFoundException - id not found

NullArgumentException - id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIds

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

Gets a list of the Ids assigned to an ontology.

Parameters:

ontologyId - Id of the Ontology

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.