org.osid.course.requisite

Interface ProgramRequirementForm

All Superinterfaces:

Extensible, Identifiable, OsidAggregateableForm, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

getRequiresCompletionMetadata

Metadata getRequiresCompletionMetadata()

Gets the metadata for the requires completion flag.

Returns:

metadata for the requires completion flag

Compliance:

mandatory - This method must be implemented.

setRequiresCompletion

void setRequiresCompletion(boolean completion)

Sets the requires completion flag.

Parameters:

completion - the new requires completion flag

Throws:

InvalidArgumentException - completion is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearRequiresCompletion

void clearRequiresCompletion()

Clears the requires completion flag.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getTimeframeMetadata

Metadata getTimeframeMetadata()

Gets the metadata for the timeframe.

Returns:

metadata for the timeframe

Compliance:

mandatory - This method must be implemented.

setTimeframe

void setTimeframe(Duration duration)

Sets the timeframe.

Parameters:

duration - the new duration

Throws:

InvalidArgumentException - duration is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - duration is null

Compliance:

mandatory - This method must be implemented.

clearTimeframe

void clearTimeframe()

Clears the timeframe.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getMinimumGPSSystemMetadata

Metadata getMinimumGPSSystemMetadata()

Gets the metadata for the minimum GPA system.

Returns:

metadata for the minimum GPA system

Compliance:

mandatory - This method must be implemented.

setMinimumGPASystem

void setMinimumGPASystem(Id gradeSystemId)

Sets the minimum GPA system.

Parameters:

gradeSystemId - the new grade system

Throws:

InvalidArgumentException - gradeSystemId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearMinimumGPASystem

void clearMinimumGPASystem()

Clears the minimum GPA system.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getMinimumGPAMetadata

Metadata getMinimumGPAMetadata()

Gets the metadata for the minimum GPA.

Returns:

metadata for the minimum GPA

Compliance:

mandatory - This method must be implemented.

setMinimumGPA

void setMinimumGPA(java.math.BigDecimal gpa)

Sets the minimum GPA.

Parameters:

gpa - the new grade

Throws:

InvalidArgumentException - grade is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearMinimumGPA

void clearMinimumGPA()

Clears the minimum GPA.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getMinimumEarnedCreditsMetadata

Metadata getMinimumEarnedCreditsMetadata()

Gets the metadata for the minimum earned credits

Returns:

metadata for the minimum earned credits

Compliance:

mandatory - This method must be implemented.

setMinimumEarnedCredits

void setMinimumEarnedCredits(java.math.BigDecimal credits)

Sets the minimum earned credits.

Parameters:

credits - the new minimum earned credits

Throws:

InvalidArgumentException - credits is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearMinimumEarnedCredits

void clearMinimumEarnedCredits()

Clears the minimum earned credits.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getProgramRequirementFormRecord

ProgramRequirementFormRecord getProgramRequirementFormRecord(Type programRequirementRecordType)
                                                             throws OperationFailedException

Gets the ProgramRequirementFormRecord corresponding to the given program requirement record Type.

Parameters:

programRequirementRecordType - a program requirement record type

Returns:

the program requirement form record

Throws:

NullArgumentException - programRequirementRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programRequirementRecordType) is false

Compliance:

mandatory - This method must be implemented.