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

Modifier and Type	Method	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 Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type.

Methods inherited from interface OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Modifier and Type	Method	Description
State	getEndReason()	Gets a state indicating why this relationship has ended.
Id	getEndReasonId()	Gets a state Id indicating why this relationship has ended.
boolean	hasEndReason()	Tests if a reason this relationship came to an end is known.

Methods inherited from interface Temporal

getEndDate, getStartDate, isEffective

Modifier and Type	Method	Description
DateTime	getEndDate()	Gets the end date.
DateTime	getStartDate()	Gets the start date.
boolean	isEffective()	Tests if the current date is within the start end end dates inclusive.

Method Details

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.