org.osid.recognition

Interface AcademyForm

All Superinterfaces:

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

All Known Subinterfaces:

AcademyBatchForm

public interface AcademyForm
extends OsidCatalogForm

This is the form for creating and updating Academies. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AcademyAdminSession. 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
AcademyFormRecord	getAcademyFormRecord(Type academyRecordType) Gets the AcademyFormRecord corresponding to the given academy 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

getAcademyFormRecord

AcademyFormRecord getAcademyFormRecord(Type academyRecordType)
                                       throws OperationFailedException

Gets the AcademyFormRecord corresponding to the given academy record Type.

Parameters:

academyRecordType - the academy record type

Returns:

the academy form record

Throws:

NullArgumentException - academyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(academyRecordType) is false

Compliance:

mandatory - This method must be implemented.