public interface HoldEnablerForm extends OsidEnablerForm
This is the form for creating and updating HoldEnablers.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
HoldEnablerAdminSession.
For each data element that may be set,
metadata may be examined to provide display hints or data constraints.
Modifier and Type | Method and Description |
---|---|
HoldEnablerFormRecord |
getHoldEnablerFormRecord(Type holdEnablerRecordType)
Gets the
HoldEnablerFormRecord corresponding to the
given hold enabler record Type. |
clearCyclicEvent, clearDemographic, clearEvent, clearSchedule, getCyclicEventMetadata, getDemographicMetadata, getEventMetadata, getScheduleMetadata, setCyclicEvent, setDemographic, setEvent, setSchedule
clearRule, getRuleMetadata, setRule
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
HoldEnablerFormRecord getHoldEnablerFormRecord(Type holdEnablerRecordType) throws OperationFailedException
HoldEnablerFormRecord
corresponding to the
given hold enabler record Type.
holdEnablerRecordType
- a hold enabler record typeNullArgumentException
- holdEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(holdEnablerRecordType)
is false
mandatory
- This method must be implemented.