org.osid.course.syllabus

Interface SyllabusForm

All Superinterfaces:

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

All Known Subinterfaces:

SyllabusBatchForm

public interface SyllabusForm
extends OsidObjectForm, OsidSubjugateableForm

This is the form for creating and updating Syllabus objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the SyllabusAdminSession. 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
SyllabusFormRecord	getSyllabusFormRecord(Type syllabusRecordType) Gets the SyllabusFormRecord corresponding to the given syllabus 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

getSyllabusFormRecord

SyllabusFormRecord getSyllabusFormRecord(Type syllabusRecordType)
                                         throws OperationFailedException

Gets the SyllabusFormRecord corresponding to the given syllabus record Type.

Parameters:

syllabusRecordType - the syllabus record type

Returns:

the syllabus form record

Throws:

NullArgumentException - syllabusRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(syllabusRecordType) is false

Compliance:

mandatory - This method must be implemented.