org.osid.repository.rules

Interface CompositionEnabler

All Superinterfaces:

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

public interface CompositionEnabler
extends OsidEnabler

A CompositionEnabler describes the rules for making Compositions visible in the composition hierarchy.

Method Summary

Methods

Modifier and Type	Method and Description
CompositionEnablerRecord	getCompositionEnablerRecord(Type compositionEnablerRecordType) Gets the composition enabler record corresponding to the given CompositionEnabler 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

getCompositionEnablerRecord

CompositionEnablerRecord getCompositionEnablerRecord(Type compositionEnablerRecordType)
                                                     throws OperationFailedException

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

Parameters:

compositionEnablerRecordType - the type of composition enabler record to retrieve

Returns:

the composition enabler record

Throws:

NullArgumentException - compositionEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(compositionEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.