public interface CommitmentEnabler extends OsidEnabler
A CommitmentEnabler
describes the rules for making
Commitments
effective.
Modifier and Type | Method and Description |
---|---|
CommitmentEnablerRecord |
getCommitmentEnablerRecord(Type commitmentEnablerRecordType)
Gets the commitment enabler record corresponding to the given
CommitmentEnabler record Type. |
getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
getEndDate, getStartDate, isEffective
CommitmentEnablerRecord getCommitmentEnablerRecord(Type commitmentEnablerRecordType) throws OperationFailedException
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
.commitmentEnablerRecordType
- the type of commitment enabler
record to retrieveNullArgumentException
-
commitmentEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(commitmentEnablerRecordType)
is
false
mandatory
- This method must be implemented.