org.osid.recognition

Interface AwardForm

All Superinterfaces:

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

All Known Subinterfaces:

AwardBatchForm

public interface AwardForm
extends OsidObjectForm

This is the form for creating and updating Awards. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AwardAdminSession. 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
AwardFormRecord	getAwardFormRecord(Type awardRecordType) Gets the AwardFormRecord corresponding to the given award 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

Method Detail

getAwardFormRecord

AwardFormRecord getAwardFormRecord(Type awardRecordType)
                                   throws OperationFailedException

Gets the AwardFormRecord corresponding to the given award record Type.

Parameters:

awardRecordType - the award record type

Returns:

the award form record

Throws:

NullArgumentException - awardRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(awardRecordType) is false

Compliance:

mandatory - This method must be implemented.