OSID - osid.voting.CandidateForm Service Interface Definition

Interface	osid.voting.CandidateForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.voting.batch.CandidateBatchForm`
Used By	`osid.voting.CandidateAdminSession`
Description	This is the form for creating and updating `Candidates` . Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `CandidateAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getResourceMetadata
Description	Gets the metadata for the associated resource.
Return	`osid.Metadata`		metadata for the resource
Compliance	`mandatory`		This method must be implemented.
Method	setResource
Description	Sets the resource.
Parameters	`osid.id.Id`	`resourceId`	the resource `Id`
Errors	INVALID_ARGUMENT		`resourceId` is invalid
	NULL_ARGUMENT		`resourceId` is null
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearResource
Description	Clears the resource.
Compliance	`mandatory`		This method must be implemented.
Method	getCandidateFormRecord
Description	Gets the `CandidateFormRecord` corresponding to the given `Candidate` record `Type` .
Parameters	`osid.type.Type`	`candidateRecordType`	the candidate record type
Return	`osid.voting.records.CandidateFormRecord`		the candidate form record
Errors	NULL_ARGUMENT		`candidateRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(candidateRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.