OSID Logo
OSID Specifications
ontology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.rules.RelevancyEnablerOntologyAssignmentSession
Implementsosid.OsidSession
Description

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 ).

MethodcanAssignRelevancyEnablers
Description

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.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignRelevancyEnablersToOntology
Description

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.

Parametersosid.id.IdontologyIdthe Id of the Ontology
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT ontologyId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableOntologyIds
Description

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

Parametersosid.id.IdontologyIdthe Id of the Ontology
Returnosid.id.IdListlist of assignable ontology Ids
ErrorsNULL_ARGUMENT ontologyId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableOntologyIdsForRelevancyEnabler
Description

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

Parametersosid.id.IdontologyIdthe Id of the Ontology
osid.id.IdrelevancyEnablerIdthe Id of the RelevancyEnabler
Returnosid.id.IdListlist of assignable ontology Ids
ErrorsNULL_ARGUMENT ontologyId or relevancyEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignRelevancyEnablerToOntology
Description

Adds an existing RelevancyEnabler to an Ontology.

Parametersosid.id.IdrelevancyEnablerIdthe Id of the RelevancyEnabler
osid.id.IdontologyIdthe Id of the Ontology
ErrorsALREADY_EXISTS relevancyEnablerId is already assigned to ontologyId
NOT_FOUND relevancyEnablerId or ontologyId not found
NULL_ARGUMENT relevancyEnablerId or ontologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignRelevancyEnablerFromOntology
Description

Removes a RelevancyEnabler from an Ontology.

Parametersosid.id.IdrelevancyEnablerIdthe Id of the RelevancyEnabler
osid.id.IdontologyIdthe Id of the Ontology
ErrorsNOT_FOUND relevancyEnablerId or ontologyId not found or relevancyEnablerId not assigned to ontologyId
NULL_ARGUMENT relevancyEnablerId or ontologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignRelevancyEnablerToOntology
Description

Moves a RelevancyEnabler from one Ontology to another. Mappings to other Ontologies are unaffected.

Parametersosid.id.IdrelevancyEnablerIdthe Id of the RelevancyEnabler
osid.id.IdfromOntologyIdthe Id of the current Ontology
osid.id.IdtoOntologyIdthe Id of the destination Ontology
ErrorsNOT_FOUND relevancyEnablerId, fromOntologyId, or toOntologyId not found or relevancyEnablerId not mapped to fromOntologyId
NULL_ARGUMENT relevancyEnablerId, fromOntologyId, or toOntologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.