org.osid.ontology.rules

Interface RelevancyEnabler

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRule, Temporal

public interface RelevancyEnabler
extends OsidEnabler

A RelevancyEnabler describes the rules for making a Relevancy effective.

Method Summary

Methods

Modifier and Type	Method and Description
RelevancyEnablerRecord	getRelevancyEnablerRecord(Type relevancyEnablerRecordType) Gets the relevancy enabler record corresponding to the given RelevancyEnabler record Type.

Methods inherited from interface org.osid.OsidEnabler

getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

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.Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getRelevancyEnablerRecord

RelevancyEnablerRecord getRelevancyEnablerRecord(Type relevancyEnablerRecordType)
                                                 throws OperationFailedException

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

Parameters:

relevancyEnablerRecordType - the type of relevancy enabler record to retrieve

Returns:

the relevancy enabler record

Throws:

NullArgumentException - relevancyEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relevancyEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.