OSID - osid.course.TermForm Service Interface Definition

Interface	osid.course.TermForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidFederateableForm`
Implemented By	`osid.course.batch.TermBatchForm`
Used By	`osid.course.TermAdminSession`
Description	This is the form for creating and updating `Terms`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `TermAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getDisplayLabelMetadata
Description	Gets the metadata for a display label title.
Return	`osid.Metadata`		metadata for the display label
Compliance	`mandatory`		This method must be implemented.
Method	setDisplayLabel
Description	Sets the display label.
Parameters	`string`	`displayLabel`	the new display label
Errors	INVALID_ARGUMENT		`displayLabel` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`displayLabel` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDisplayLabel
Description	Removes the display label.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getOpenDateMetadata
Description	Gets the metadata for an open date.
Return	`osid.Metadata`		metadata for the open date
Compliance	`mandatory`		This method must be implemented.
Method	setOpenDate
Description	Sets the open date.
Parameters	`osid.calendaring.DateTime`	`date`	the new open date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`date` cannot be modified
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOpenDate
Description	Clears the open date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationStartMetadata
Description	Gets the metadata for the registration start date.
Return	`osid.Metadata`		metadata for the registration start date
Compliance	`mandatory`		This method must be implemented.
Method	setRegistrationStart
Description	Sets the registration start date.
Parameters	`osid.calendaring.DateTime`	`date`	the new registration start date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`date` cannot be modified
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRegistrationStart
Description	Clears the registration start date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationEndMetadata
Description	Gets the metadata for the registration end date.
Return	`osid.Metadata`		metadata for the registration end date
Compliance	`mandatory`		This method must be implemented.
Method	setRegistrationEnd
Description	Sets the registration end date.
Parameters	`osid.calendaring.DateTime`	`date`	the new registration end date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`date` cannot be modified
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRegistrationEnd
Description	Clears the registration end date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getClassesStartMetadata
Description	Gets the metadata for the classes start date.
Return	`osid.Metadata`		metadata for the classes start date
Compliance	`mandatory`		This method must be implemented.
Method	setClassesStart
Description	Sets the classes start date.
Parameters	`osid.calendaring.DateTime`	`date`	the new classes start date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`date` cannot be modified
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearClassesStart
Description	Clears the classes start date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getClassesEndMetadata
Description	Gets the metadata for the classes end date.
Return	`osid.Metadata`		metadata for the classes end date
Compliance	`mandatory`		This method must be implemented.
Method	setClassesEnd
Description	Sets the classes end date.
Parameters	`osid.calendaring.DateTime`	`date`	the new classes end date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`date` cannot be modified
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearClassesEnd
Description	Clears the classes end date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAddDateMetadata
Description	Gets the metadata for the add date.
Return	`osid.Metadata`		metadata for the add date
Compliance	`mandatory`		This method must be implemented.
Method	setAddDate
Description	Sets the add date.
Parameters	`osid.calendaring.DateTime`	`date`	the new add date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`date` cannot be modified
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAddDate
Description	Clears the add date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDropDateMetadata
Description	Gets the metadata for the drop date.
Return	`osid.Metadata`		metadata for the drop date
Compliance	`mandatory`		This method must be implemented.
Method	setDropDate
Description	Sets the drop date.
Parameters	`osid.calendaring.DateTime`	`date`	the new drop date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`date` cannot be modified
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDropDate
Description	Clears the drop date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getFinalExamStartMetadata
Description	Gets the metadata for the classes start date.
Return	`osid.Metadata`		metadata for the classes start date
Compliance	`mandatory`		This method must be implemented.
Method	setFinalExamStart
Description	Sets the final exam start date.
Parameters	`osid.calendaring.DateTime`	`date`	the new final exam start date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`date` cannot be modified
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFinalExamStart
Description	Clears the final exam start date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getFinalExamEndMetadata
Description	Gets the metadata for the final exam end date.
Return	`osid.Metadata`		metadata for the final exam end date
Compliance	`mandatory`		This method must be implemented.
Method	setFinalExamEnd
Description	Sets the final exam end date.
Parameters	`osid.calendaring.DateTime`	`date`	the new final exam end date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`date` cannot be modified
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFinalExamEnd
Description	Clears the final exam end date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCloseDateMetadata
Description	Gets the metadata for the close date.
Return	`osid.Metadata`		metadata for the close date
Compliance	`mandatory`		This method must be implemented.
Method	setCloseDate
Description	Sets the close date.
Parameters	`osid.calendaring.DateTime`	`date`	the new close date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`date` cannot be modified
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCloseDate
Description	Clears the close date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTermFormRecord
Description	Gets the `TermFormRecord` corresponding to the given term record `Type`.
Parameters	`osid.type.Type`	`termRecordType`	a term record type
Return	`osid.course.records.TermFormRecord`		the term form record
Errors	NULL_ARGUMENT		`termRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(termRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.