org.osid.configuration.rules

Interface ParameterProcessorEnabler

All Superinterfaces:

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

public interface ParameterProcessorEnabler
extends OsidEnabler

A ParameterProcessorEnabler describes the rules for making a ParameterProcessor effective.

Method Summary

Methods

Modifier and Type	Method and Description
ParameterProcessorEnablerRecord	getParameterProcessorEnablerRecord(Type parameterProcessorEnablerRecordType) Gets the parameter processor enabler record corresponding to the given ParameterProcessorEnabler 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

getParameterProcessorEnablerRecord

ParameterProcessorEnablerRecord getParameterProcessorEnablerRecord(Type parameterProcessorEnablerRecordType)
                                                                   throws OperationFailedException

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

Parameters:

parameterProcessorEnablerRecordType - the type of parameter processor enabler record to retrieve

Returns:

the parameter processor enabler record

Throws:

NullArgumentException - parameterProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.