org.osid.resourcing.rules

Interface CommissionEnabler

All Superinterfaces:

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

public interface CommissionEnabler
extends OsidEnabler

A CommissionEnabler describes the rules for managing the effectiveness of Commissions.

Method Summary

Methods

Modifier and Type	Method and Description
CommissionEnablerRecord	getCommissionEnablerRecord(Type commissionEnablerRecordType) Gets the commission enabler record corresponding to the given CommissionEnabler 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

getCommissionEnablerRecord

CommissionEnablerRecord getCommissionEnablerRecord(Type commissionEnablerRecordType)
                                                   throws OperationFailedException

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

Parameters:

commissionEnablerRecordType - the type of commission enabler record to retrieve

Returns:

the commission enabler record

Throws:

NullArgumentException - commissionEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commissionEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.