OSID - osid.course.ActivityUnitForm Service Interface Definition

Interface	osid.course.ActivityUnitForm
Implements	`osid.OsidObjectForm`
	`osid.OsidOperableForm`
	`osid.OsidSubjugateableForm`
Implemented By	`osid.course.batch.ActivityUnitBatchForm`
Used By	`osid.course.ActivityUnitAdminSession`
Description	This is the form for creating and updating `ActivityUnits`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `ActivityUnitAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getTotalTargetEffortMetadata
Description	Gets the metadata for the total effort. The amount may be calculated from the other data.
Return	`osid.Metadata`		metadata for the total effort
Compliance	`mandatory`		This method must be implemented.
Method	setTotalTargetEffort
Description	Sets the total effort.
Parameters	`osid.calendaring.Duration`	`time`	the new total effort
Errors	INVALID_ARGUMENT		`time` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`time` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTotalTargetEffort
Description	Removes the total effort.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getContactMetadata
Description	Gets the metadata for the contact flag.
Return	`osid.Metadata`		metadata for the contact
Compliance	`mandatory`		This method must be implemented.
Method	setContact
Description	Sets the contact flag.
Parameters	`boolean`	`contact`	the new contact flag
Errors	INVALID_ARGUMENT		`contact` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearContact
Description	Removes the contact flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTotalTargetContactTimeMetadata
Description	Gets the metadata for the total contact time.
Return	`osid.Metadata`		metadata for the total contact time
Compliance	`mandatory`		This method must be implemented.
Method	setTotalTargetContactTime
Description	Sets the total contact time.
Parameters	`osid.calendaring.Duration`	`time`	the new total contact time
Errors	INVALID_ARGUMENT		`time` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`time` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTotalTargetContactTime
Description	Removes the total contact time.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTotalTargetIndividualEffortMetadata
Description	Gets the metadata for the total individual effort. The amount may be calculated from the other data.
Return	`osid.Metadata`		metadata for the total individual effort
Compliance	`mandatory`		This method must be implemented.
Method	setTotalTargetIndividualEffort
Description	Sets the total individual effort.
Parameters	`osid.calendaring.Duration`	`time`	the new total individual effort
Errors	INVALID_ARGUMENT		`time` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`time` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTotalTargetIndividualEffort
Description	Removes the total individual effort.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringWeeklyMetadata
Description	Gets the metadata for the recurring weekly flag.
Return	`osid.Metadata`		metadata for the contact
Compliance	`mandatory`		This method must be implemented.
Method	setRecurringWeekly
Description	Sets the recurring weekly flag.
Parameters	`boolean`	`recurring`	the new recurring weekly flag
Errors	INVALID_ARGUMENT		`recurring` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearRecurringWeekly
Description	Removes the recurring weekly flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getWeeklyEffortMetadata
Description	Gets the metadata for the weekly effort. The amount may be calculated from the other data.
Return	`osid.Metadata`		metadata for the weekly effort
Compliance	`mandatory`		This method must be implemented.
Method	setWeeklyEffort
Description	Sets the weekly effort.
Parameters	`osid.calendaring.Duration`	`time`	the new weekly effort
Errors	INVALID_ARGUMENT		`time` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`time` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWeeklyEffort
Description	Removes the weekly effort.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getWeeklyContactTimeMetadata
Description	Gets the metadata for the weekly contact time.
Return	`osid.Metadata`		metadata for the weekly contact time
Compliance	`mandatory`		This method must be implemented.
Method	setWeeklyContactTime
Description	Sets the weekly contact time.
Parameters	`osid.calendaring.Duration`	`time`	the new weekly contact time
Errors	INVALID_ARGUMENT		`time` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`time` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWeeklyContactTime
Description	Removes the weekly contact time.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getWeeklyIndividualEffortMetadata
Description	Gets the metadata for the weekly individual effort. The amount may be calculated from the other data.
Return	`osid.Metadata`		metadata for the weekly individual effort
Compliance	`mandatory`		This method must be implemented.
Method	setWeeklyIndividualEffort
Description	Sets the weekly individual effort.
Parameters	`osid.calendaring.Duration`	`time`	the new weekly individual effort
Errors	INVALID_ARGUMENT		`time` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`time` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWeeklyIndividualEffort
Description	Removes the weekly individual effort.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectivesMetadata
Description	Gets the metadata for a set of learning objectives.
Return	`osid.Metadata`		metadata for the obecjtives
Compliance	`mandatory`		This method must be implemented.
Method	setLearningObjectives
Description	Sets the learning objectives.
Parameters	`osid.id.Id[]`	`objectiveIds`	the new obejctives
Errors	INVALID_ARGUMENT		`objectiveIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`objectiveIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectives
Description	Removes the learning objectives.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitFormRecord
Description	Gets the `ActivityUnitFormRecord` corresponding to the given activity unit record `Type`.
Parameters	`osid.type.Type`	`activityUnitRecordType`	an activity unit record type
Return	`osid.course.records.ActivityUnitFormRecord`		the activity unit form record
Errors	NULL_ARGUMENT		`activityUnitRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(activityUnitRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.