OSID Logo
OSID Specifications
voting package
Version 3.1.0
Interfaceosid.voting.CandidateForm
Implementsosid.OsidRelationshipForm
Implemented Byosid.voting.batch.CandidateBatchForm
Used Byosid.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.

MethodgetResourceMetadata
Description

Gets the metadata for the associated resource.

Returnosid.Metadata metadata for the resource
Compliancemandatory This method must be implemented.
MethodsetResource
Description

Sets the resource.

Parametersosid.id.IdresourceId the resource Id
ErrorsINVALID_ARGUMENT resourceId is invalid
NULL_ARGUMENT resourceId is null
NO_ACCESS Metadata.isReadOnly() is true
Compliancemandatory This method must be implemented.
MethodclearResource
Description

Clears the resource.

Compliancemandatory This method must be implemented.
MethodgetCandidateFormRecord
Description

Gets the CandidateFormRecord corresponding to the given Candidate record Type.

Parametersosid.type.TypecandidateRecordType the candidate record type
Returnosid.voting.records.CandidateFormRecord the candidate form record
ErrorsNULL_ARGUMENT candidateRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(candidateRecordType) is false
Compliancemandatory This method must be implemented.