OSID - osid.voting.BallotForm Service Interface Definition

Interface	osid.voting.BallotForm
Implements	`osid.OsidGovernatorForm`
Implements	`osid.OsidTemporalForm`
Implemented By	`osid.voting.batch.BallotBatchForm`
Used By	`osid.voting.BallotAdminSession`
Description	This is the form for creating and updating `Ballots` . Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `BallotAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getCommissionersMetadata
Description	Gets the metadata for the commissioners.
Return	`osid.Metadata`		metadata for the commissioners
Compliance	`mandatory`		This method must be implemented.
Method	setCommissioners
Description	Sets the commissioners.
Parameters	`osid.id.IdList`	`commissionerIds`	the new commissioners
Errors	INVALID_ARGUMENT		`commissionerIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`commissionerIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCommissioners
Description	Removes the commissioners.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRevoteMetadata
Description	Gets the metadata for the revote flag.
Return	`osid.Metadata`		metadata for the revote flag
Compliance	`mandatory`		This method must be implemented.
Method	setRevote
Description	Sets the revote flag.
Parameters	`boolean`	`revote`	the revote flag
Errors	INVALID_ARGUMENT		`revote` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearRevote
Description	Clears the revote flag.
Compliance	`mandatory`		This method must be implemented.
Method	getBallotFormRecord
Description	Gets the `BallotFormRecord` corresponding to the given `Ballot` record `Type` .
Parameters	`osid.type.Type`	`candidateRecordType`	the ballot record type
Return	`osid.voting.records.BallotFormRecord`		the ballot form record
Errors	NULL_ARGUMENT		`ballotRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(ballotRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.