public interface ValueEnabler extends OsidEnabler
A ValueEnabler
describes the rules for making a
Value
active.
Modifier and Type | Method and Description |
---|---|
ValueEnablerRecord |
getValueEnablerRecord(Type valueEnablerRecordType)
Gets the value enabler record corresponding to the given
ValueEnabler 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
ValueEnablerRecord getValueEnablerRecord(Type valueEnablerRecordType) throws OperationFailedException
ValueEnabler
record Type.
This method is used
to retrieve an object implementing the requested record. The
valueEnablerRecordType
may be the Type
returned
in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(valueEnablerRecordType)
is true
.valueEnablerRecordType
- the type of value enabler record to
retrieveNullArgumentException
- valueEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(valueEnablerRecordType)
is false
mandatory
- This method must be implemented.