org.osid.provisioning.rules

Interface PoolProcessorEnabler

All Superinterfaces:

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

public interface PoolProcessorEnabler
extends OsidEnabler

A PoolProcessorEnabler describes the rules for making a PoolProcessor effective.

Method Summary

Methods

Modifier and Type	Method and Description
PoolProcessorEnablerRecord	getPoolProcessorEnablerRecord(Type poolProcessorEnablerRecordType) Gets the pool processor enabler record corresponding to the given PoolProcessorEnabler 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

getPoolProcessorEnablerRecord

PoolProcessorEnablerRecord getPoolProcessorEnablerRecord(Type poolProcessorEnablerRecordType)
                                                         throws OperationFailedException

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

Parameters:

poolProcessorEnablerRecordType - the type of pool processor enabler record to retrieve

Returns:

the pool processor enabler record

Throws:

NullArgumentException - poolProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.