org.osid.workflow.rules

Interface StepProcessor

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidObject, OsidProcessor, OsidRule

public interface StepProcessor
extends OsidProcessor

A StepProcessor describes the rules for managing the behavior of a step.

Method Summary

Methods

Modifier and Type	Method and Description
StepProcessorRecord	getStepProcessorRecord(Type stepProcessorRecordType) Gets the step processor record corresponding to the given StepProcessor record Type.

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

Method Detail

getStepProcessorRecord

StepProcessorRecord getStepProcessorRecord(Type stepProcessorRecordType)
                                           throws OperationFailedException

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

Parameters:

stepProcessorRecordType - the type of step processor record to retrieve

Returns:

the step processor record

Throws:

NullArgumentException - stepProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.