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

This session provides methods to re-assign Relevancies to Ontologies. A Relevancy may map to multiple Ontologies and removing the last reference to a Relevancy 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 Relevancy to another Ontology is not a copy operation (eg: does not change its Id ).

MethodcanAssignRelevancies
Description

Tests if this user can alter relevancy/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 assignment operations to unauthorized users.

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

Tests if this user can alter relevancy/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 assignment 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 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.
MethodgetAssignableOntologyIdsForRelevancy
Description

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

Parametersosid.id.IdontologyIdthe Id of the Ontology
osid.id.IdrelevancyIdthe Id of the Relevancy
Returnosid.id.IdListlist of assignable ontology Ids
ErrorsNULL_ARGUMENT ontologyId or relevancyId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignRelevancyToOntology
Description

Adds an existing Relevancy to an Ontology.

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

Removes a Relevancy from an Ontology.

Parametersosid.id.IdrelevancyIdthe Id of the Relevancy
osid.id.IdontologyIdthe Id of the Ontology
ErrorsNOT_FOUND relevancyId or ontologyId not found or relevancyId not assigned to ontologyId
NULL_ARGUMENT relevancyId or ontologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignRelevancyToOntology
Description

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

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