org.osid.workflow.rules

Interface ProcessEnabler

All Superinterfaces:

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

public interface ProcessEnabler
extends OsidEnabler

A ProcessEnabler describes the rules for constraining the resources in a process.

Method Summary

Methods

Modifier and Type	Method and Description
ProcessEnablerRecord	getProcessEnablerRecord(Type processEnablerRecordType) Gets the process enabler record corresponding to the given ProcessEnabler 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

getProcessEnablerRecord

ProcessEnablerRecord getProcessEnablerRecord(Type processEnablerRecordType)
                                             throws OperationFailedException

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

Parameters:

processEnablerRecordType - the type of process enabler record to retrieve

Returns:

the process enabler record

Throws:

NullArgumentException - processEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.