org.osid.provisioning.rules

Interface PoolConstrainerEnabler

All Superinterfaces:

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

public interface PoolConstrainerEnabler
extends OsidEnabler

A PoolConstrainerEnabler describes the rules for making a PoolConstrainer effective.

Method Summary

Methods

Modifier and Type	Method and Description
PoolConstrainerEnablerRecord	getPoolConstrainerEnablerRecord(Type poolConstrainerEnablerRecordType) Gets the pool constrainer enabler record corresponding to the given PoolConstrainerEnabler 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

getPoolConstrainerEnablerRecord

PoolConstrainerEnablerRecord getPoolConstrainerEnablerRecord(Type poolConstrainerEnablerRecordType)
                                                             throws OperationFailedException

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

Parameters:

poolConstrainerEnablerRecordType - the type of pool constrainer enabler record to retrieve

Returns:

the pool constrainer enabler record

Throws:

NullArgumentException - poolConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.