Interface ProfileEntryEnablerForm
- All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidEnablerForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, OsidTemporalForm, Suppliable
This is the form for creating and updating
ProfileEntryEnablers. Like all OsidForm objects, various data
elements may be set here for use in the create and update methods in the
ProfileEntryEnablerAdminSession. For each data element that may be
set, metadata may be examined to provide display hints or data
constraints.
Like all OsidForms, ProfileEntryEnablerForm is
stateful and must not be accessed by multiple processing threads.
-
Method Summary
Modifier and TypeMethodDescriptiongetProfileEntryEnablerFormRecord(Type profileEntryEnablerRecordType) Gets theProfileEntryEnablerFormRecordcorresponding to the given profile entry enabler recordType.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeMethods inherited from interface Identifiable
getId, isCurrentMethods inherited from interface OsidEnablerForm
clearCyclicEvent, clearCyclicTimePeriod, clearEvent, clearRequirement, clearSchedule, clearTimePeriod, getCyclicEventMetadata, getCyclicTimePeriodPeriodMetadata, getEventMetadata, getRequirementMetadata, getScheduleMetadata, getTimePeriodPeriodMetadata, setCyclicEvent, setCyclicTimePeriod, setEvent, setRequirement, setSchedule, setTimePeriodMethods inherited from interface OsidExtensibleForm
getRequiredRecordTypesMethods inherited from interface OsidForm
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocaleMethods inherited from interface OsidObjectForm
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusTypeMethods inherited from interface OsidOperableForm
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabledMethods inherited from interface OsidRuleForm
clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRuleMethods inherited from interface OsidTemporalForm
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
-
Method Details
-
getProfileEntryEnablerFormRecord
ProfileEntryEnablerFormRecord getProfileEntryEnablerFormRecord(Type profileEntryEnablerRecordType) throws OperationFailedException Gets theProfileEntryEnablerFormRecordcorresponding to the given profile entry enabler recordType.- Parameters:
profileEntryEnablerRecordType- a profile entry enabler record type- Returns:
- the profile entry enabler form record
- Throws:
NullArgumentException-profileEntryEnablerRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(profileEntryEnablerRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-