OSID - osid.course.requisite.ProgramRequirement Service Interface Definition

Interface	osid.course.requisite.ProgramRequirement
Implements	`osid.OsidRule`
Implements	`osid.Aggregateable`
Used By	`osid.course.requisite.ProgramRequirementList`
	`osid.course.requisite.Requisite`
	`osid.course.requisite.RequisiteAdminSession`
	`osid.course.requisite.RequisiteLookupSession`
Description	A `ProgramRequirement` is an `OsidRule` and represents a requirement based on the completion or enrollment for a `Program`.
Method	getAltRequisites
Description	Gets any `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.
Return	`osid.course.requisite.Requisite[]`		the alternate requisites
Compliance	`mandatory`		This method must be implemented.
Method	getProgramId
Description	Gets the `Id` of the `Program`.
Return	`osid.id.Id`		the program `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getProgram
Description	Gets the `Program`.
Return	`osid.course.program.Program`		the program
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	requiresCompletion
Description	Tests if this requirement requires completion of the program.
Return	`boolean`		`true` if a completion of the program is required, `false` if enrollment in the program is required
Compliance	`mandatory`		This method must be implemented.
Method	hasTimeframe
Description	Tests if the program must be completed within the required duration.
Return	`boolean`		`true` if the program has to be completed within a required time, `false` if it could have been completed at any time in the past
Compliance	`mandatory`		This method must be implemented.
Method	getTimeframe
Description	Gets the timeframe in which the program has to be completed. A negative duration indicates the program had to be completed within the specified amount of time in the past. A posiitive duration indicates the program must be completed within the specified amount of time in the future. A zero duration indicates the program must be completed in the current term.
Return	`osid.calendaring.Duration`		the time frame
Errors	ILLEGAL_STATE		`hasTimeframe()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasMinimumGPA
Description	Tests if a minimum GPA above passing is required in the completion of the program or maintained at this level during enrollment.
Return	`boolean`		`true` if a minimum gpa is required, `false` if the course just has to be passed
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumGPASystemId
Description	Gets the scoring system `Id` for the minimum GPA.
Return	`osid.id.Id`		the scoring system `Id`
Errors	ILLEGAL_STATE		`hasMinimumGPA()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumGPASystem
Description	Gets the scoring system for the minimum GPA.
Return	`osid.grading.GradeSystem`		the scoring system
Errors	ILLEGAL_STATE		`hasMinimumGPA()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumGPA
Description	Gets the minimum GPA.
Return	`decimal`		the minimum gpa
Errors	ILLEGAL_STATE		`hasMinimumGPA()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasMinimumEarnedCredits
Description	Tests if a minimum credits earned in the program is required.
Return	`boolean`		`true` if a minimum credits is required, `false` otehrwise
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumEarnedCredits
Description	Gets the minimum earned credits.
Return	`decimal`		the minimum credits
Errors	ILLEGAL_STATE		`hasMinimumEarnedCredits()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramRequirementRecord
Description	Gets the program requirement record corresponding to the given `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`.
Parameters	`osid.type.Type`	`programRequirementRecordType`	the type of program requirement record to retrieve
Return	`osid.course.requisite.records.ProgramRequirementRecord`		the program requirement record
Errors	NULL_ARGUMENT		`programRequirementRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programRequirementRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.