OSID - osid.calendaring.TimePeriodForm Service Interface Definition

Interface	osid.calendaring.TimePeriodForm
Implements	`osid.OsidObjectForm`
Implemented By	`osid.calendaring.batch.TimePeriodBatchForm`
Used By	`osid.calendaring.TimePeriodAdminSession`
Description	This is the form for creating and updating `TimePeriods`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `TimePeriodAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getStartMetadata
Description	Gets the metadata for a start time.
Return	`osid.Metadata`		metadata for the start time
Compliance	`mandatory`		This method must be implemented.
Method	setStart
Description	Sets the start time.
Parameters	`osid.calendaring.DateTime`	`start`	the new start time
Errors	INVALID_ARGUMENT		`start` is invalid
	NO_ACCESS		`start` cannot be modified
	NULL_ARGUMENT		`start` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStart
Description	Clears the start time.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getEndMetadata
Description	Gets the metadata for an end time.
Return	`osid.Metadata`		metadata for the end time
Compliance	`mandatory`		This method must be implemented.
Method	setEnd
Description	Sets the end time.
Parameters	`osid.calendaring.DateTime`	`end`	the new end time
Errors	INVALID_ARGUMENT		`end` is invalid
	NO_ACCESS		`end` cannot be modified
	NULL_ARGUMENT		`end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEnd
Description	Clears the time period end.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodFormRecord
Description	Gets the `TimePeriodFormRecord` corresponding to the given time period record `Type`.
Parameters	`osid.type.Type`	`timePeriodRecordType`	the time period record type
Return	`osid.calendaring.records.TimePeriodFormRecord`		the time period form record
Errors	NULL_ARGUMENT		`timePeriodRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(timePeriodRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.