org.osid.workflow.rules

Interface StepConstrainerEnabler

All Superinterfaces:

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

public interface StepConstrainerEnabler
extends OsidEnabler

A StepConstrainerEnabler describes the rules for making a StepConstrainer effective.

Method Summary

Methods

Modifier and Type	Method and Description
StepConstrainerEnablerRecord	getStepConstrainerEnablerRecord(Type stepConstrainerEnablerRecordType) Gets the step constrainer enabler record corresponding to the given StepConstrainerEnabler 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

getStepConstrainerEnablerRecord

StepConstrainerEnablerRecord getStepConstrainerEnablerRecord(Type stepConstrainerEnablerRecordType)
                                                             throws OperationFailedException

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

Parameters:

stepConstrainerEnablerRecordType - the type of step constrainer enabler record to retrieve

Returns:

the step constrainer enabler record

Throws:

NullArgumentException - stepConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.