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