org.osid.configuration.rules

Interface ValueEnabler

All Superinterfaces:

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

public interface ValueEnabler
extends OsidEnabler

A ValueEnabler describes the rules for making a Value active.

Method Summary

Methods

Modifier and Type	Method and Description
ValueEnablerRecord	getValueEnablerRecord(Type valueEnablerRecordType) Gets the value enabler record corresponding to the given ValueEnabler 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

getValueEnablerRecord

ValueEnablerRecord getValueEnablerRecord(Type valueEnablerRecordType)
                                         throws OperationFailedException

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

Parameters:

valueEnablerRecordType - the type of value enabler record to retrieve

Returns:

the value enabler record

Throws:

NullArgumentException - valueEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(valueEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.