org.osid.ontology.rules

Interface RelevancyEnablerOntologyAssignmentSession

All Superinterfaces:

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

public interface RelevancyEnablerOntologyAssignmentSession
extends OsidSession

This session provides methods to re-assign RelevancyEnabler to Ontology mappings. A RelevancyEnabler may appear in multiple Ontology objects and removing the last reference to a RelevancyEnabler is the equivalent of deleting it. Each Ontology may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a RelevancyEnabler to another Ontology is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignRelevancyEnablerToOntology(Id relevancyEnablerId, Id ontologyId) Adds an existing RelevancyEnabler to an Ontology.
boolean	canAssignRelevancyEnablers() Tests if this user can alter relevancy enabler/ontology mappings.
boolean	canAssignRelevancyEnablersToOntology(Id ontologyId) Tests if this user can alter relevancy enabler/ontology mappings.
IdList	getAssignableOntologyIds(Id ontologyId) Gets a list of ontologies including and under the given ontology node in which any relevancy enabler can be assigned.
IdList	getAssignableOntologyIdsForRelevancyEnabler(Id ontologyId, Id relevancyEnablerId) Gets a list of ontologies including and under the given ontology node in which a specific relevancy enabler can be assigned.
void	unassignRelevancyEnablerFromOntology(Id relevancyEnablerId, Id ontologyId) Removes a RelevancyEnabler 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

canAssignRelevancyEnablers

boolean canAssignRelevancyEnablers()

Tests if this user can alter relevancy enabler/ontology mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignRelevancyEnablersToOntology

boolean canAssignRelevancyEnablersToOntology(Id ontologyId)

Tests if this user can alter relevancy enabler/ontology mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Parameters:

ontologyId - the Id of the Ontology

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - ontologyId is null

Compliance:

mandatory - This method must be implemented.

getAssignableOntologyIds

IdList getAssignableOntologyIds(Id ontologyId)
                                throws OperationFailedException

Gets a list of ontologies including and under the given ontology node in which any relevancy enabler can be assigned.

Parameters:

ontologyId - the Id of the Ontology

Returns:

list of assignable ontology Ids

Throws:

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableOntologyIdsForRelevancyEnabler

IdList getAssignableOntologyIdsForRelevancyEnabler(Id ontologyId,
                                                 Id relevancyEnablerId)
                                                   throws OperationFailedException

Gets a list of ontologies including and under the given ontology node in which a specific relevancy enabler can be assigned.

Parameters:

ontologyId - the Id of the Ontology

relevancyEnablerId - the Id of the RelevancyEnabler

Returns:

list of assignable ontology Ids

Throws:

NullArgumentException - ontologyId or relevancyEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignRelevancyEnablerToOntology

void assignRelevancyEnablerToOntology(Id relevancyEnablerId,
                                    Id ontologyId)
                                      throws AlreadyExistsException,
                                             NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Adds an existing RelevancyEnabler to an Ontology.

Parameters:

relevancyEnablerId - the Id of the RelevancyEnabler

ontologyId - the Id of the Ontology

Throws:

AlreadyExistsException - relevancyEnablerId is already assigned to ontologyId

NotFoundException - relevancyEnablerId or ontologyId not found

NullArgumentException - relevancyEnablerId or ontologyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignRelevancyEnablerFromOntology

void unassignRelevancyEnablerFromOntology(Id relevancyEnablerId,
                                        Id ontologyId)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Removes a RelevancyEnabler from an Ontology.

Parameters:

relevancyEnablerId - the Id of the RelevancyEnabler

ontologyId - the Id of the Ontology

Throws:

NotFoundException - relevancyEnablerId or ontologyId not found or relevancyEnablerId not assigned to ontologyId

NullArgumentException - relevancyEnablerId or ontologyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.