org.osid.profile.rules

Interface ProfileEntryEnabler

All Superinterfaces:

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

public interface ProfileEntryEnabler
extends OsidEnabler

A ProfileEntryEnabler describes the rules for making Profiles effective.

Method Summary

Methods

Modifier and Type	Method and Description
ProfileEntryEnablerRecord	getProfileEntryEnablerRecord(Type profileEntryEnablerRecordType) Gets the profile entry enabler record corresponding to the given ProfileEntryEnabler 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

getProfileEntryEnablerRecord

ProfileEntryEnablerRecord getProfileEntryEnablerRecord(Type profileEntryEnablerRecordType)
                                                       throws OperationFailedException

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

Parameters:

profileEntryEnablerRecordType - the type of profile entry enabler record to retrieve

Returns:

the profile entry enabler record

Throws:

NullArgumentException - profileEntryEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileEntryEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.