org.osid.workflow.rules

Interface StepConstrainer

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidConstrainer, OsidObject, OsidRule

public interface StepConstrainer
extends OsidConstrainer

A StepConstrainer describes the rules for constraining the workflow requests in a step.

Method Summary

Methods

Modifier and Type	Method and Description
StepConstrainerRecord	getStepConstrainerRecord(Type stepConstrainerRecordType) Gets the step constrainer record corresponding to the given StepConstrainer 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

getStepConstrainerRecord

StepConstrainerRecord getStepConstrainerRecord(Type stepConstrainerRecordType)
                                               throws OperationFailedException

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

Parameters:

stepConstrainerRecordType - the type of step constrainer record to retrieve

Returns:

the step constrainer record

Throws:

NullArgumentException - stepConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.