OSID Logo
OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.CandidateForm
Implementsosid.OsidRelationshipForm
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.Metadatametadata for the resource
CompliancemandatoryThis method must be implemented.
MethodsetResource
Description

Sets the resource.

Parametersosid.id.IdresourceIdthe resource Id
ErrorsINVALID_ARGUMENT resourceId is invalid
NULL_ARGUMENT resourceId is null
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearResource
Description

Clears the resource.

CompliancemandatoryThis method must be implemented.
MethodgetCandidateFormRecord
Description

Gets the CandidateFormRecord corresponding to the given Candidate record Type.

Parametersosid.type.TypecandidateRecordTypethe candidate record type
Returnosid.voting.records.CandidateFormRecordthe candidate form record
ErrorsNULL_ARGUMENT candidateRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(candidateRecordType) is false
CompliancemandatoryThis method must be implemented.