OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.Relevancy
Implementsosid.OsidRelationship
Description

A Relevancy maps an Id to an Subject.

MethodgetSubjectId
Description

Gets the subject Id.

Returnosid.id.Idthe subject Id
CompliancemandatoryThis method must be implemented.
MethodgetSubject
Description

Gets the Subject.

Returnosid.ontology.Subjectthe subject
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetMappedId
Description

Gets the Id mapped to this Subject.

Returnosid.id.Ida mapped Id
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyRecord
Description

Gets the relevancy record corresponding to the given Relevancy record Type. This method must is to retrieve an object implementing the requested record. The relevancyRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(relevancyRecordType) is true .

Parametersosid.type.TyperelevancyRecordTypethe type of the record to retrieve
Returnosid.ontology.records.RelevancyRecordthe relevancy record
ErrorsNULL_ARGUMENT relevancyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(relevancyRecordType) is false
CompliancemandatoryThis method must be implemented.