OSID - osid.offering.CanonicalUnitForm Service Interface Definition

Interface	osid.offering.CanonicalUnitForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidOperableForm`
Implemented By	`osid.offering.batch.CanonicalUnitBatchForm`
Used By	`osid.offering.CanonicalUnitAdminSession`
Description	This is the form for creating and updating `CanonicalUnits`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `CanonicalUnitAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getTitleMetadata
Description	Gets the metadata for a title.
Return	`osid.Metadata`		metadata for the title
Compliance	`mandatory`		This method must be implemented.
Method	setTitle
Description	Sets the title.
Parameters	`string`	`title`	the title
Errors	INVALID_ARGUMENT		`title` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`title` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearTitle
Description	Clears the title.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCodeMetadata
Description	Gets the metadata for a given name.
Return	`osid.Metadata`		metadata for the given name
Compliance	`mandatory`		This method must be implemented.
Method	setCode
Description	Sets the code.
Parameters	`string`	`code`	the 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	getOfferedCyclicTimePeriodsMetadata
Description	Gets the metadata for a the cyclic time periods.
Return	`osid.Metadata`		metadata for the cyclic time periods
Compliance	`mandatory`		This method must be implemented.
Method	setOfferedCyclicTimePeriods
Description	Sets the cyclic time periods.
Parameters	`osid.id.Id[]`	`cyclicTimePeriodIds`	the cyclic time periods
Errors	INVALID_ARGUMENT		`cylciPeriodIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`cyclicPeriodIds` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearOfferedCyclicTimePeriods
Description	Clears the cyclic time periods.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getResultOptionsMetadata
Description	Gets the metadata for the grading options.
Return	`osid.Metadata`		metadata for the prerequisite information
Compliance	`mandatory`		This method must be implemented.
Method	setResultOptions
Description	Sets the grading options.
Parameters	`osid.id.Id[]`	`gradeSystemIds`	the new grading options
Errors	INVALID_ARGUMENT		`gradeSystemIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`gradeSystemIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResultOptions
Description	Removes the grading options.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSponsorsMetadata
Description	Gets the metadata for the sponsors.
Return	`osid.Metadata`		metadata for the sponsors
Compliance	`mandatory`		This method must be implemented.
Method	setSponsors
Description	Sets the sponsors.
Parameters	`osid.id.Id[]`	`sponsorIds`	the new sponsors
Errors	INVALID_ARGUMENT		`sponsorIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`sponsorIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSponsors
Description	Removes the sponsors.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitFormRecord
Description	Gets the `CanonicalUnitFormRecord` interface corresponding to the given canonical unit record `Type`.
Parameters	`osid.type.Type`	`canonicalUnitRecordType`	the canonical unit record type
Return	`osid.offering.records.CanonicalUnitFormRecord`		the record
Errors	NULL_ARGUMENT		`canonicalUnitRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(canonicalUnitRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.