org.osid.voting

Interface CandidateForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

CandidateBatchForm

public interface CandidateForm
extends OsidRelationshipForm

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 Summary

Methods

Modifier and Type	Method and Description
void	clearResource() Clears the resource.
CandidateFormRecord	getCandidateFormRecord(Type candidateRecordType) Gets the CandidateFormRecord corresponding to the given Candidate record Type.
Metadata	getResourceMetadata() Gets the metadata for the associated resource.
void	setResource(Id resourceId) Sets the resource.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getResourceMetadata

Metadata getResourceMetadata()

Gets the metadata for the associated resource.

Returns:

metadata for the resource

Compliance:

mandatory - This method must be implemented.

setResource

void setResource(Id resourceId)

Sets the resource.

Parameters:

resourceId - the resource Id

Throws:

InvalidArgumentException - resourceId is invalid

NullArgumentException - resourceId is null

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearResource

void clearResource()

Clears the resource.

Compliance:

mandatory - This method must be implemented.

getCandidateFormRecord

CandidateFormRecord getCandidateFormRecord(Type candidateRecordType)
                                           throws OperationFailedException

Gets the CandidateFormRecord corresponding to the given Candidate record Type.

Parameters:

candidateRecordType - the candidate record type

Returns:

the candidate form record

Throws:

NullArgumentException - candidateRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(candidateRecordType) is false

Compliance:

mandatory - This method must be implemented.