OSID - osid.resourcing.EffortForm Service Interface Definition

Interface	osid.resourcing.EffortForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.resourcing.batch.EffortBatchForm`
Used By	`osid.resourcing.EffortAdminSession`
Description	This is the form for creating and updating `Efforts` .Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `EffortAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getTimeSpentMetadata
Description	Gets the metadata for the time spent.
Return	`osid.Metadata`		metadata for the time spent
Compliance	`mandatory`		This method must be implemented.
Method	setTimeSpent
Description	Sets the time spent.
Parameters	`osid.calendaring.Duration`	`timeSpent`	the new time spent
Errors	INVALID_ARGUMENT		`timeSpent` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`timeSpent` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeSpent
Description	Removes the time spent.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getEffortFormRecord
Description	Gets the `EffortFormRecord` corresponding to the given effort record `Type` .
Parameters	`osid.type.Type`	`effortRecordType`	an effort record type
Return	`osid.resourcing.records.EffortFormRecord`		the effort form record
Errors	NULL_ARGUMENT		`effortRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(effortRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.