org.osid.resource.demographic

Interface DemographicEnabler

All Superinterfaces:

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

public interface DemographicEnabler
extends OsidEnabler

A DemographicEnabler describes the rules for enabling and disabling a Demographic.

Method Summary

Methods

Modifier and Type	Method and Description
DemographicEnablerRecord	getDemographicEnablerRecord(Type demographicEnablerRecordType) Gets the demographic enabler record corresponding to the given DemographicEnabler 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

getDemographicEnablerRecord

DemographicEnablerRecord getDemographicEnablerRecord(Type demographicEnablerRecordType)
                                                     throws OperationFailedException

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

Parameters:

demographicEnablerRecordType - the type of demographic enabler record to retrieve

Returns:

the demographic enabler record

Throws:

NullArgumentException - demographicEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(demographicEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.