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

Interface	osid.course.chronicle.CredentialEntryForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.course.chronicle.batch.CredentialEntryBatchForm`
Used By	`osid.course.chronicle.CredentialEntryAdminSession`
Description	This is the form for creating and updating `CredentialEntries`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `ChronicleAdminSession`. 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	getStartDateMetadata
Description	Gets the metadata for the start date.
Return	`osid.Metadata`		metadata for the start date
Compliance	`mandatory`		This method must be implemented.
Method	setStartDate
Description	Sets the start 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	clearStartDate
Description	Clears the start date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getStartTermMetadata
Description	Gets the metadata for the start term.
Return	`osid.Metadata`		metadata for the start term
Compliance	`mandatory`		This method must be implemented.
Method	setStartTerm
Description	Sets the start term.
Parameters	`osid.id.Id`	`startTermId`	the new start term
Errors	INVALID_ARGUMENT		`startTermId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`startTermId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStartTerm
Description	Clears the start 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	getIsActivelyPursuingMetadata
Description	Gets the metadata for the is actively pursuing flag.
Return	`osid.Metadata`		metadata for the is actively pursuing flag
Compliance	`mandatory`		This method must be implemented.
Method	setIsActivelyPursuing
Description	Sets the is actively pursuing flag.
Parameters	`boolean`	`isActivelyPursuing`	the new is actively pursuing flag
Errors	INVALID_ARGUMENT		`isActivelyPursuing` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearIsActivelyPursuing
Description	Clears the is actively pursuing flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIsPausedMetadata
Description	Gets the metadata for the is paused flag.
Return	`osid.Metadata`		metadata for the is paused flag
Compliance	`mandatory`		This method must be implemented.
Method	setIsPaused
Description	Sets the is paused flag.
Parameters	`boolean`	`isPaused`	the new is paused flag
Errors	INVALID_ARGUMENT		`isPaused` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearIsPaused
Description	Clears the is paused flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIsAbandonedMetadata
Description	Gets the metadata for the is abandoned flag.
Return	`osid.Metadata`		metadata for the is abandoned flag
Compliance	`mandatory`		This method must be implemented.
Method	setIsAbandoned
Description	Sets the is abandoned flag.
Parameters	`boolean`	`isAbandoned`	the new is abandoned flag
Errors	INVALID_ARGUMENT		`isAbandoned` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearIsAbandoned
Description	Clears the is abandoned flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAbandonDateMetadata
Description	Gets the metadata for the abandon date.
Return	`osid.Metadata`		metadata for the abandon date
Compliance	`mandatory`		This method must be implemented.
Method	setAbandonDate
Description	Sets the abandon 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	clearAbandonDate
Description	Clears the abandon date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAbandonTermMetadata
Description	Gets the metadata for the abandon term.
Return	`osid.Metadata`		metadata for the abandon term
Compliance	`mandatory`		This method must be implemented.
Method	setAbandonTerm
Description	Sets the abandon term.
Parameters	`osid.id.Id`	`abandonTermId`	the new abandon term
Errors	INVALID_ARGUMENT		`abandonTermId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`abandonTermId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAbandonTerm
Description	Clears the abandon term.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIsAwardedMetadata
Description	Gets the metadata for the is awarded flag.
Return	`osid.Metadata`		metadata for the is awarded flag
Compliance	`mandatory`		This method must be implemented.
Method	setIsAwarded
Description	Sets the is awarded flag.
Parameters	`boolean`	`isAwarded`	the new is awarded flag
Errors	INVALID_ARGUMENT		`isAwarded` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearIsAwarded
Description	Clears the is awarded flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAwardDateMetadata
Description	Gets the metadata for the award date.
Return	`osid.Metadata`		metadata for the award date
Compliance	`mandatory`		This method must be implemented.
Method	setAwardDate
Description	Sets the award 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	clearAwardDate
Description	Clears the award date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAwardTermMetadata
Description	Gets the metadata for the award term.
Return	`osid.Metadata`		metadata for the award term
Compliance	`mandatory`		This method must be implemented.
Method	setAwardTerm
Description	Sets the award term.
Parameters	`osid.id.Id`	`awardTermId`	the new award term
Errors	INVALID_ARGUMENT		`awardTermId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`awardTermId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAwardTerm
Description	Clears the award term.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDateAwardedMetadata
Description	Gets the metadata for the award date.
Return	`osid.Metadata`		metadata for the award date
Compliance	`mandatory`		This method must be implemented.
Method	setDateAwarded
Description	Sets the award 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	clearDateAwarded
Description	Clears the award date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramMetadata
Description	Gets the metadata for the program.
Return	`osid.Metadata`		metadata for the program
Compliance	`mandatory`		This method must be implemented.
Method	setProgram
Description	Sets the program.
Parameters	`osid.id.Id`	`programId`	the new program
Errors	INVALID_ARGUMENT		`programId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`programId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProgram
Description	Clears the program.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialEntryFormRecord
Description	Gets the `CredentialEntryFormRecord` corresponding to the given credential entry record `Type`.
Parameters	`osid.type.Type`	`credentialEntryRecordType`	a credential entry record type
Return	`osid.course.chronicle.records.CredentialEntryFormRecord`		the credential entry form record
Errors	NULL_ARGUMENT		`credentialEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(credentialEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.