org.osid.control.rules

Interface ActionEnabler

All Superinterfaces:

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

public interface ActionEnabler
extends OsidEnabler

An ActionEnabler describes the rules for making an ControlConstrainer effective.

Method Summary

Methods

Modifier and Type	Method and Description
ActionEnablerRecord	getActionEnablerRecord(Type actionEnablerRecordType) Gets the action enabler record corresponding to the given ActionEnabler 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

getActionEnablerRecord

ActionEnablerRecord getActionEnablerRecord(Type actionEnablerRecordType)
                                           throws OperationFailedException

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

Parameters:

actionEnablerRecordType - the type of action enabler record to retrieve

Returns:

the action enabler record

Throws:

NullArgumentException - actionEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(actionEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.