org.osid.voting

Interface PollsForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

PollsBatchForm

public interface PollsForm
extends OsidCatalogForm

This is the form for creating and updating polls. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PollsAdminSession. 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
PollsFormRecord	getPollsFormRecord(Type pollsRecordType) Gets the PollsFormRecord corresponding to the given polls record Type.

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.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getPollsFormRecord

PollsFormRecord getPollsFormRecord(Type pollsRecordType)
                                   throws OperationFailedException

Gets the PollsFormRecord corresponding to the given polls record Type.

Parameters:

pollsRecordType - the polls record type

Returns:

the polls form record

Throws:

NullArgumentException - pollsRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pollsRecordType) is false

Compliance:

mandatory - This method must be implemented.