OSID Logo
OSID Specifications
ontology package
Version 3.1.0
Interfaceosid.ontology.Relevancy
Implementsosid.OsidRelationship
Used Byosid.ontology.RelevancyAdminSession
osid.ontology.RelevancyList
osid.ontology.RelevancyLookupSession
Description

A Relevancy maps an Id to an Subject.

MethodgetSubjectId
Description

Gets the subject Id.

Returnosid.id.Id the subject Id
Compliancemandatory This method must be implemented.
MethodgetSubject
Description

Gets the Subject.

Returnosid.ontology.Subject the subject
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetMappedId
Description

Gets the Id mapped to this Subject.

Returnosid.id.Id a mapped Id
Compliancemandatory This 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.TyperelevancyRecordType the type of the record to retrieve
Returnosid.ontology.records.RelevancyRecord the relevancy record
ErrorsNULL_ARGUMENT relevancyRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(relevancyRecordType) is false
Compliancemandatory This method must be implemented.