OSID - osid.course.chronicle.ProgramEntryForm Service Interface Definition

Interface	osid.course.chronicle.ProgramEntryForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.course.chronicle.batch.ProgramEntryBatchForm`
Used By	`osid.course.chronicle.ProgramEntryAdminSession`
Description	This is the form for creating and updating `ProgramEntries`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `ProgramEntryAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getIsMatriculationKnownMetadata
Description	Gets the metadata for the is matriculation known flag.
Return	`osid.Metadata`		metadata for the is matriculation known flag
Compliance	`mandatory`		This method must be implemented.
Method	setIsMatriculationKnown
Description	Sets the is matriculation known flag.
Parameters	`boolean`	`isMatriculationKnown`	the new is matriculation known flag
Errors	INVALID_ARGUMENT		`isMatriculationKnown` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearIsMatriculationKnown
Description	Clears the is matriculation known flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getEntranceDateMetadata
Description	Gets the metadata for the entrance date.
Return	`osid.Metadata`		metadata for the entrance date
Compliance	`mandatory`		This method must be implemented.
Method	setEntranceDate
Description	Sets the entrance date.
Parameters	`osid.calendaring.DateTime`	`date`	the new date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEntranceDate
Description	Clears the entrance date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getEntranceTermMetadata
Description	Gets the metadata for the entrance term.
Return	`osid.Metadata`		metadata for the entrance term
Compliance	`mandatory`		This method must be implemented.
Method	setEntranceTerm
Description	Sets the entrance term.
Parameters	`osid.id.Id`	`entranceTermId`	the new entrance term
Errors	INVALID_ARGUMENT		`entranceTermId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`entranceTermId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEntranceTerm
Description	Clears the entrance term.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIsExpectedToCompleteMetadata
Description	Gets the metadata for the is expected to complete flag.
Return	`osid.Metadata`		metadata for the is expected to complete flag
Compliance	`mandatory`		This method must be implemented.
Method	setIsExpectedToComplete
Description	Sets the is expected to complete flag.
Parameters	`boolean`	`isExpectedToComplete`	the new is expected to complete flag
Errors	INVALID_ARGUMENT		`isExpectedToComplete` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearIsExpectedToComplete
Description	Clears the is expected to complete flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getExpectedCompletionDateMetadata
Description	Gets the metadata for the expected completion date.
Return	`osid.Metadata`		metadata for the expected completion date
Compliance	`mandatory`		This method must be implemented.
Method	setExpectedCompletionDate
Description	Sets the expected completion date.
Parameters	`osid.calendaring.DateTime`	`date`	the new date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearExpectedCompletionDate
Description	Clears the expected completion date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getExpectedCompletionTermMetadata
Description	Gets the metadata for the expected completion term.
Return	`osid.Metadata`		metadata for the expected completion term
Compliance	`mandatory`		This method must be implemented.
Method	setExpectedCompletionTerm
Description	Sets the expected completion term.
Parameters	`osid.id.Id`	`expectedCompletionTermId`	the new expected completion term
Errors	INVALID_ARGUMENT		`expectedCompletionTermId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`expectedCompletionTermId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearExpectedCompletionTerm
Description	Clears the expected completion term.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIsEnrolledMetadata
Description	Gets the metadata for the is enrolled flag.
Return	`osid.Metadata`		metadata for the is enrolled flag
Compliance	`mandatory`		This method must be implemented.
Method	setIsEnrolled
Description	Sets the is enrolled flag.
Parameters	`boolean`	`isEnrolled`	the new is enrolled flag
Errors	INVALID_ARGUMENT		`isEnrolled` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearIsEnrolled
Description	Clears the is enrolled flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIsActivelyEnrolledMetadata
Description	Gets the metadata for the is actively enrolled flag.
Return	`osid.Metadata`		metadata for the is actively enrolled flag
Compliance	`mandatory`		This method must be implemented.
Method	setIsActivelyEnrolled
Description	Sets the is actively enrolled flag.
Parameters	`boolean`	`isActivelyEnrolled`	the new is actively enrolled flag
Errors	INVALID_ARGUMENT		`isActivelyEnrolled` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearIsActivelyEnrolled
Description	Clears the is actively enrolled flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIsOnLeaveMetadata
Description	Gets the metadata for the is on leave flag.
Return	`osid.Metadata`		metadata for the is on leave flag
Compliance	`mandatory`		This method must be implemented.
Method	setIsOnLeave
Description	Sets the is on leave flag.
Parameters	`boolean`	`isOnLeave`	the new is on leave flag
Errors	INVALID_ARGUMENT		`isOnLeave` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearIsOnLeave
Description	Clears the is on leave flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getHasWithdrawnMetadata
Description	Gets the metadata for the has withdrawn flag.
Return	`osid.Metadata`		metadata for the has withdrawn flag
Compliance	`mandatory`		This method must be implemented.
Method	setHasWithdrawn
Description	Sets the has withdrawn flag.
Parameters	`boolean`	`hasWithdrawn`	the new has withdrawn flag
Errors	INVALID_ARGUMENT		`hasWithdrawn` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearHasWithdrawn
Description	Clears the has withdrawn flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getWithdrawDateMetadata
Description	Gets the metadata for the withdraw date.
Return	`osid.Metadata`		metadata for the withdraw date
Compliance	`mandatory`		This method must be implemented.
Method	setWithdrawDate
Description	Sets the withdraw date.
Parameters	`osid.calendaring.DateTime`	`date`	the new date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWithdrawDate
Description	Clears the withdraw date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getWithdrawTermMetadata
Description	Gets the metadata for the withdraw term.
Return	`osid.Metadata`		metadata for the withdraw term
Compliance	`mandatory`		This method must be implemented.
Method	setWithdrawTerm
Description	Sets the withdraw term.
Parameters	`osid.id.Id`	`withdrawTermId`	the new withdraw term
Errors	INVALID_ARGUMENT		`withdrawTermId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`withdrawTermId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWithdrawTerm
Description	Clears the withdraw term.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCompleteMetadata
Description	Gets the metadta for the completionm flag.
Return	`osid.Metadata`		metadata for the complete flag
Compliance	`mandatory`		This method must be implemented.
Method	setComplete
Description	Sets the program is complete flag.
Parameters	`boolean`	`complete`	the new complete flag
Errors	INVALID_ARGUMENT		`complete` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearComplete
Description	Clears the complete flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCompletionDateMetadata
Description	Gets the metadata for the completion date.
Return	`osid.Metadata`		metadata for the completion date
Compliance	`mandatory`		This method must be implemented.
Method	setCompletionDate
Description	Sets the completion date.
Parameters	`osid.calendaring.DateTime`	`date`	the new date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCompletionDate
Description	Clears the completion date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCompletionTermMetadata
Description	Gets the metadata for the completion term.
Return	`osid.Metadata`		metadata for the completion term
Compliance	`mandatory`		This method must be implemented.
Method	setCompletionTerm
Description	Sets the completion term.
Parameters	`osid.id.Id`	`completionTermId`	the new completion term
Errors	INVALID_ARGUMENT		`completionTermId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`completionTermId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCompletionTerm
Description	Clears the completion term.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLevelMetadata
Description	Gets the metadata for the level.
Return	`osid.Metadata`		metadata for the level
Compliance	`mandatory`		This method must be implemented.
Method	setLevel
Description	Sets the level.
Parameters	`osid.id.Id`	`levelId`	the new level
Errors	INVALID_ARGUMENT		`levelId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`levelId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLevel
Description	Clears the level.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getStandingMetadata
Description	Gets the metadata for the standing.
Return	`osid.Metadata`		metadata for the standing
Compliance	`mandatory`		This method must be implemented.
Method	setStanding
Description	Sets the standing.
Parameters	`osid.id.Id`	`standingId`	the new standing
Errors	INVALID_ARGUMENT		`standingId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`standingId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStanding
Description	Clears the standing.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAdmissionDateMetadata
Description	Gets the metadata for the admission date.
Return	`osid.Metadata`		metadata for the admission date
Compliance	`mandatory`		This method must be implemented.
Method	setAdmissionDate
Description	Sets the admission date.
Parameters	`osid.calendaring.DateTime`	`date`	the new date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAdmissionDate
Description	Clears the admission date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTermMetadata
Description	Gets the metadata for the term.
Return	`osid.Metadata`		metadata for the term
Compliance	`mandatory`		This method must be implemented.
Method	setTerm
Description	Sets the term.
Parameters	`osid.id.Id`	`termId`	the new term
Errors	INVALID_ARGUMENT		`termId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`termId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTerm
Description	Clears the term.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCreditScaleMetadata
Description	Gets the metadata for the credit scale.
Return	`osid.Metadata`		metadata for the credit scale
Compliance	`mandatory`		This method must be implemented.
Method	setCreditScale
Description	Sets the credit scale.
Parameters	`osid.id.Id`	`gradeSystemId`	the new grade system
Errors	INVALID_ARGUMENT		`gradeSystemId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`gradeSystemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditScale
Description	Clears the credit scale.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsEarnedMetadata
Description	Gets the metadata for the credits earned.
Return	`osid.Metadata`		metadata for the credits earned
Compliance	`mandatory`		This method must be implemented.
Method	setCreditsEarned
Description	Sets the credits earned.
Parameters	`decimal`	`credits`	the new credits
Errors	INVALID_ARGUMENT		`credits` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditsEarned
Description	Clears the credits earned.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getGPAScaleMetadata
Description	Gets the metadata for the gpa scale.
Return	`osid.Metadata`		metadata for the gpa scale
Compliance	`mandatory`		This method must be implemented.
Method	setGPAScale
Description	Sets the gpa scale.
Parameters	`osid.id.Id`	`gradeSystemId`	the new grade system
Errors	INVALID_ARGUMENT		`gradeSystemId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`gradeSystemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearGPAScale
Description	Clears the gpa scale.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getGPAMetadata
Description	Gets the metadata for the gpa.
Return	`osid.Metadata`		metadata for the gpa
Compliance	`mandatory`		This method must be implemented.
Method	setGPA
Description	Sets the gpa.
Parameters	`decimal`	`gpa`	the new gpa
Errors	INVALID_ARGUMENT		`gpa` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearGPA
Description	Clears the gpa.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntryFormRecord
Description	Gets the `ProgramEntryFormRecord` corresponding to the given program entry record `Type`.
Parameters	`osid.type.Type`	`programEntryRecordType`	a program entry record type
Return	`osid.course.chronicle.records.ProgramEntryFormRecord`		the program entry form record
Errors	NULL_ARGUMENT		`programEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.