org.osid.hold.rules

Interface HoldEnabler

All Superinterfaces:

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

public interface HoldEnabler
extends OsidEnabler

A HoldEnabler describes the rules for making Holds effective.

Method Summary

Methods

Modifier and Type	Method and Description
HoldEnablerRecord	getHoldEnablerRecord(Type holdEnablerRecordType) Gets the hold enabler record corresponding to the given HoldEnabler 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

getHoldEnablerRecord

HoldEnablerRecord getHoldEnablerRecord(Type holdEnablerRecordType)
                                       throws OperationFailedException

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

Parameters:

holdEnablerRecordType - the type of hold enabler record to retrieve

Returns:

the hold enabler record

Throws:

NullArgumentException - holdEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(holdEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.