OSID - osid.ontology.SubjectForm Service Interface Definition

Interface	osid.ontology.SubjectForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidFederateableForm`
Implemented By	`osid.ontology.batch.SubjectBatchForm`
Used By	`osid.ontology.SubjectAdminSession`
Description	This is the form for creating and updating `Subjects` .Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `SubjectAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getCodeMetadata
Description	Gets the metadata for the code.
Return	`osid.Metadata`		metadata for the code
Compliance	`mandatory`		This method must be implemented.
Method	setCode
Description	Sets the code.
Parameters	`string`	`code`	the new code
Errors	INVALID_ARGUMENT		`code` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`code` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCode
Description	Clears the code.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSubjectFormRecord
Description	Gets the `SubjectFormRecord` corresponding to the given subject record `Type` .
Parameters	`osid.type.Type`	`subjectRecordType`	the subject record type
Return	`osid.ontology.records.SubjectFormRecord`		the subject form record
Errors	NULL_ARGUMENT		`subjectRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(subjectRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.