org.osid.relationship.rules

Interface RelationshipEnabler

All Superinterfaces:

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

public interface RelationshipEnabler
extends OsidEnabler

A RelationshipEnabler describes the rules for making Relationships effective.

Method Summary

Methods

Modifier and Type	Method and Description
RelationshipEnablerRecord	getRelationshipEnablerRecord(Type relationshipEnablerRecordType) Gets the relationship enabler record corresponding to the given RelationshipEnabler 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

getRelationshipEnablerRecord

RelationshipEnablerRecord getRelationshipEnablerRecord(Type relationshipEnablerRecordType)
                                                       throws OperationFailedException

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

Parameters:

relationshipEnablerRecordType - the type of relationship enabler record to retrieve

Returns:

the relationship enabler record

Throws:

NullArgumentException - relationshipEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relationshipEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.