org.osid.resourcing.rules

Interface JobProcessorEnabler

All Superinterfaces:

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

public interface JobProcessorEnabler
extends OsidEnabler

A JobProcessorEnabler describes the rules for making a JobProcessor effective.

Method Summary

Methods

Modifier and Type	Method and Description
JobProcessorEnablerRecord	getJobProcessorEnablerRecord(Type jobProcessorEnablerRecordType) Gets the job processor enabler record corresponding to the given JobProcessorEnabler 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

getJobProcessorEnablerRecord

JobProcessorEnablerRecord getJobProcessorEnablerRecord(Type jobProcessorEnablerRecordType)
                                                       throws OperationFailedException

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

Parameters:

jobProcessorEnablerRecordType - the type of job processor enabler record to retrieve

Returns:

the job processor enabler record

Throws:

NullArgumentException - jobProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(jobProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.