OSID - osid.offering.ParticipantForm Service Interface Definition

Interface	osid.offering.ParticipantForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.offering.batch.ParticipantBatchForm`
Used By	`osid.offering.ParticipantAdminSession`
Description	This is the form for creating and updating `Participants` . Like all `OsidForms` , various data elements may be set here for use in the create and update methods in the `ParticipantAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getTimePeriodMetadata
Description	Gets the metadata for a time period.
Return	`osid.Metadata`		metadata for the time period
Compliance	`mandatory`		This method must be implemented.
Method	setTimePeriod
Description	Sets the time period.
Parameters	`osid.id.Id`	`timePeriodId`	the time period
Errors	INVALID_ARGUMENT		`timePeriodId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`timePeriodId` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearTimePeriod
Description	Clears the time period.
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	getParticipantFormRecord
Description	Gets the `ParticipantFormRecord` interface corresponding to the given participant record `Type` .
Parameters	`osid.type.Type`	`participantRecordType`	the participant record type
Return	`osid.offering.records.ParticipantFormRecord`		the record
Errors	NULL_ARGUMENT		`participantRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(participantRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.