org.osid.workflow.rules

Interface StepProcessorEnabler

All Superinterfaces:

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

public interface StepProcessorEnabler
extends OsidEnabler

A StepProcessorEnabler describes the rules for making a StepProcessor effective.

Method Summary

Methods

Modifier and Type	Method and Description
StepProcessorEnablerRecord	getStepProcessorEnablerRecord(Type stepProcessorEnablerRecordType) Gets the step processor enabler record corresponding to the given StepProcessorEnabler 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

getStepProcessorEnablerRecord

StepProcessorEnablerRecord getStepProcessorEnablerRecord(Type stepProcessorEnablerRecordType)
                                                         throws OperationFailedException

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

Parameters:

stepProcessorEnablerRecordType - the type of step processor enabler record to retrieve

Returns:

the step processor enabler record

Throws:

NullArgumentException - stepProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.