public interface ProgramRequirement extends OsidRule, Aggregateable
A ProgramRequirement
is an OsidRule
and
represents a requirement based on the completion or enrollment for a
Program.
Modifier and Type | Method and Description |
---|---|
Requisite[] |
getAltRequisites()
Gets any
Requisites that may be substituted in place of
this ProgramRequirement. |
java.math.BigDecimal |
getMinimumEarnedCredits()
Gets the minimum earned credits.
|
java.math.BigDecimal |
getMinimumGPA()
Gets the minimum GPA.
|
GradeSystem |
getMinimumGPASystem()
Gets the scoring system for the minimum GPA.
|
Id |
getMinimumGPASystemId()
Gets the scoring system
Id for the minimum GPA. |
Program |
getProgram()
Gets the
Program. |
Id |
getProgramId()
Gets the
Id of the Program. |
ProgramRequirementRecord |
getProgramRequirementRecord(Type programRequirementRecordType)
Gets the program requirement record corresponding to the given
ProgramRequirement record Type. |
Duration |
getTimeframe()
Gets the timeframe in which the program has to be completed.
|
boolean |
hasMinimumEarnedCredits()
Tests if a minimum credits earned in the program is required.
|
boolean |
hasMinimumGPA()
Tests if a minimum GPA above passing is required in the completion of
the program or maintained at this level during enrollment.
|
boolean |
hasTimeframe()
Tests if the program must be completed within the required duration.
|
boolean |
requiresCompletion()
Tests if this requirement requires completion of the program.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
Requisite[] getAltRequisites()
Requisites
that may be substituted in place of
this ProgramRequirement.
All Requisites
must be satisifed to be a substitute for this program requirement.
Inactive Requisites
are not evaluated but if no
applicable requisite exists, then the alternate requisite is not
satisifed.mandatory
- This method must be implemented. Id getProgramId()
Id
of the Program.
Id
mandatory
- This method must be implemented. Program getProgram() throws OperationFailedException
Program.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean requiresCompletion()
true
if a completion of the program is
required, false
if enrollment in the program is
requiredmandatory
- This method must be implemented. boolean hasTimeframe()
true
if the program has to be completed within
a required time, false
if it could have been
completed at any time in the pastmandatory
- This method must be implemented. Duration getTimeframe()
IllegalStateException
- hasTimeframe()
is false
mandatory
- This method must be implemented. boolean hasMinimumGPA()
true
if a minimum gpa is required, false
if the course just has to be passedmandatory
- This method must be implemented. Id getMinimumGPASystemId()
Id
for the minimum GPA. Id
IllegalStateException
- hasMinimumGPA()
is false
mandatory
- This method must be implemented. GradeSystem getMinimumGPASystem() throws OperationFailedException
IllegalStateException
- hasMinimumGPA()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. java.math.BigDecimal getMinimumGPA()
IllegalStateException
- hasMinimumGPA()
is false
mandatory
- This method must be implemented. boolean hasMinimumEarnedCredits()
true
if a minimum credits is required,
false
otehrwisemandatory
- This method must be implemented. java.math.BigDecimal getMinimumEarnedCredits()
IllegalStateException
-
hasMinimumEarnedCredits()
is false
mandatory
- This method must be implemented. ProgramRequirementRecord getProgramRequirementRecord(Type programRequirementRecordType) throws OperationFailedException
ProgramRequirement
record Type.
This method is
used to retrieve an object implementing the requested record. The
programRequirementRecordType
may be the Type
returned in getRecordTypes()
or any of its
parents in a Type
hierarchy where
hasRecordType(programRequirementRecordType)
is true
.programRequirementRecordType
- the type of program requirement
record to retrieveNullArgumentException
-
programRequirementRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(programRequirementRecordType)
is
false
mandatory
- This method must be implemented.