org.osid.offering.rules

Interface CanonicalUnitProcessorEnabler

All Superinterfaces:

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

public interface CanonicalUnitProcessorEnabler
extends OsidEnabler

An CanonicalUnitProcessorEnabler describes the rules for making an CanonicalUnitProcessor effective.

Method Summary

Methods

Modifier and Type	Method and Description
CanonicalUnitProcessorEnablerRecord	getCanonicalUnitProcessorEnablerRecord(Type canonicalUnitProcessorEnablerRecordType) Gets the canonical unit processor enabler record corresponding to the given CanonicalUnitProcessorEnabler 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

getCanonicalUnitProcessorEnablerRecord

CanonicalUnitProcessorEnablerRecord getCanonicalUnitProcessorEnablerRecord(Type canonicalUnitProcessorEnablerRecordType)
                                                                           throws OperationFailedException

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

Parameters:

canonicalUnitProcessorEnablerRecordType - the type of canonical unit processor enabler record to retrieve

Returns:

the canonical unit processor enabler record

Throws:

NullArgumentException - canonicalUnitProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.