public interface AwardRequirementForm extends OsidRuleForm, OsidAggregateableForm
This is the form for creating and updating AwardRequirements.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
RequisiteAdminSession.
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 |
---|---|
void |
clearTimeframe()
Clears the timeframe.
|
AwardRequirementFormRecord |
getAwardlRequirementFormRecord(Type awardRequirementRecordType)
Gets the
AwardRequirementFormRecord corresponding to
the given awardl requirement record Type. |
Metadata |
getTimeframeMetadata()
Gets the metadata for the timeframe.
|
void |
setTimeframe(Duration duration)
Sets the timeframe.
|
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
Metadata getTimeframeMetadata()
mandatory
- This method must be implemented. void setTimeframe(Duration duration)
duration
- the new durationInvalidArgumentException
- duration
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- duration
is
null
mandatory
- This method must be implemented. void clearTimeframe()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. AwardRequirementFormRecord getAwardlRequirementFormRecord(Type awardRequirementRecordType) throws OperationFailedException
AwardRequirementFormRecord
corresponding to
the given awardl requirement record Type.
awardRequirementRecordType
- an award requirement record typeNullArgumentException
-
awardRequirementRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(awardRequirementRecordType)
is
false
mandatory
- This method must be implemented.