Interface IssueEnablerForm
- All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidEnablerForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, OsidTemporalForm, Suppliable
This is the form for creating and updating IssueEnablers. Like
all OsidForms, various data elements may be set here for use in
the create and update methods in the IssueEnablerAdminSession. F
or each data element that may be set, metadata may be examined to provide
display hints or data constraints.
Like all OsidForms, IssueEnablerForm is stateful and
must not be accessed by multiple processing threads.
-
Method Summary
Modifier and TypeMethodDescriptiongetIssueEnablerFormRecord(Type issueEnablerRecordType) Gets theIssueEnablerFormRecordcorresponding to the given issue 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
-
getIssueEnablerFormRecord
IssueEnablerFormRecord getIssueEnablerFormRecord(Type issueEnablerRecordType) throws OperationFailedException Gets theIssueEnablerFormRecordcorresponding to the given issue enabler recordType.- Parameters:
issueEnablerRecordType- an issue enabler record type- Returns:
- the issue enabler form record
- Throws:
NullArgumentException-issueEnablerRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(issueEnablerRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-