org.osid.inquiry.rules

Interface InquiryEnabler

All Superinterfaces:

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

public interface InquiryEnabler
extends OsidEnabler

An InquiryEnabler describes the rules for making an Audit effective.

Method Summary

Methods

Modifier and Type	Method and Description
InquiryEnablerRecord	getInquiryEnablerRecord(Type inquiryEnablerRecordType) Gets the inquiry enabler record corresponding to the given InquiryEnabler 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

getInquiryEnablerRecord

InquiryEnablerRecord getInquiryEnablerRecord(Type inquiryEnablerRecordType)
                                             throws OperationFailedException

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

Parameters:

inquiryEnablerRecordType - the type of inquiry enabler record to retrieve

Returns:

the inquiry enabler record

Throws:

NullArgumentException - inquiryEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inquiryEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.