public interface ProgramRequirementForm extends OsidRuleForm, OsidAggregateableForm
This is the form for creating and updating ProgramRequirements.
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 |
clearMinimumEarnedCredits()
Clears the minimum earned credits.
|
void |
clearMinimumGPA()
Clears the minimum GPA.
|
void |
clearMinimumGPASystem()
Clears the minimum GPA system.
|
void |
clearRequiresCompletion()
Clears the requires completion flag.
|
void |
clearTimeframe()
Clears the timeframe.
|
Metadata |
getMinimumEarnedCreditsMetadata()
Gets the metadata for the minimum earned credits
|
Metadata |
getMinimumGPAMetadata()
Gets the metadata for the minimum GPA.
|
Metadata |
getMinimumGPSSystemMetadata()
Gets the metadata for the minimum GPA system.
|
ProgramRequirementFormRecord |
getProgramRequirementFormRecord(Type programRequirementRecordType)
Gets the
ProgramRequirementFormRecord corresponding to
the given program requirement record Type. |
Metadata |
getRequiresCompletionMetadata()
Gets the metadata for the requires completion flag.
|
Metadata |
getTimeframeMetadata()
Gets the metadata for the timeframe.
|
void |
setMinimumEarnedCredits(java.math.BigDecimal credits)
Sets the minimum earned credits.
|
void |
setMinimumGPA(java.math.BigDecimal gpa)
Sets the minimum GPA.
|
void |
setMinimumGPASystem(Id gradeSystemId)
Sets the minimum GPA system.
|
void |
setRequiresCompletion(boolean completion)
Sets the requires completion flag.
|
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 getRequiresCompletionMetadata()
mandatory
- This method must be implemented. void setRequiresCompletion(boolean completion)
completion
- the new requires completion flagInvalidArgumentException
- completion
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearRequiresCompletion()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. 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. Metadata getMinimumGPSSystemMetadata()
mandatory
- This method must be implemented. void setMinimumGPASystem(Id gradeSystemId)
gradeSystemId
- the new grade systemInvalidArgumentException
- gradeSystemId
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- gradeSystemId
is
null
mandatory
- This method must be implemented. void clearMinimumGPASystem()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getMinimumGPAMetadata()
mandatory
- This method must be implemented. void setMinimumGPA(java.math.BigDecimal gpa)
gpa
- the new gradeInvalidArgumentException
- grade
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearMinimumGPA()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getMinimumEarnedCreditsMetadata()
mandatory
- This method must be implemented. void setMinimumEarnedCredits(java.math.BigDecimal credits)
credits
- the new minimum earned creditsInvalidArgumentException
- credits
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearMinimumEarnedCredits()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ProgramRequirementFormRecord getProgramRequirementFormRecord(Type programRequirementRecordType) throws OperationFailedException
ProgramRequirementFormRecord
corresponding to
the given program requirement record Type.
programRequirementRecordType
- a program requirement record typeNullArgumentException
-
programRequirementRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(programRequirementRecordType)
is
false
mandatory
- This method must be implemented.