org.osid.calendaring.rules

Interface CommitmentEnabler

All Superinterfaces:

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

public interface CommitmentEnabler
extends OsidEnabler

A CommitmentEnabler describes the rules for making Commitments effective.

Method Summary

Methods

Modifier and Type	Method and Description
CommitmentEnablerRecord	getCommitmentEnablerRecord(Type commitmentEnablerRecordType) Gets the commitment enabler record corresponding to the given CommitmentEnabler 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

getCommitmentEnablerRecord

CommitmentEnablerRecord getCommitmentEnablerRecord(Type commitmentEnablerRecordType)
                                                   throws OperationFailedException

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

Parameters:

commitmentEnablerRecordType - the type of commitment enabler record to retrieve

Returns:

the commitment enabler record

Throws:

NullArgumentException - commitmentEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commitmentEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.