org.osid.ontology

Interface Relevancy

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface Relevancy
extends OsidRelationship

A Relevancy maps an Id to an Subject.

Method Summary

Methods

Modifier and Type	Method and Description
Id	getMappedId() Gets the Id mapped to this Subject.
RelevancyRecord	getRelevancyRecord(Type relevancyRecordType) Gets the relevancy record corresponding to the given Relevancy record Type.
Subject	getSubject() Gets the Subject.
Id	getSubjectId() Gets the subject Id.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getSubjectId

Id getSubjectId()

Gets the subject Id.

Returns:

the subject Id

Compliance:

mandatory - This method must be implemented.

getSubject

Subject getSubject()
                   throws OperationFailedException

Gets the Subject.

Returns:

the subject

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getMappedId

Id getMappedId()

Gets the Id mapped to this Subject.

Returns:

a mapped Id

Compliance:

mandatory - This method must be implemented.

getRelevancyRecord

RelevancyRecord getRelevancyRecord(Type relevancyRecordType)
                                   throws OperationFailedException

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 .

Parameters:

relevancyRecordType - the type of the record to retrieve

Returns:

the relevancy record

Throws:

NullArgumentException - relevancyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relevancyRecordType) is false

Compliance:

mandatory - This method must be implemented.