org.osid.ontology

Interface SubjectForm

All Superinterfaces:

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

All Known Subinterfaces:

SubjectBatchForm

public interface SubjectForm
extends OsidObjectForm, OsidFederateableForm

This is the form for creating and updating Subjects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the SubjectAdminSession. 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
SubjectFormRecord	getSubjectFormRecord(Type subjectRecordType) Gets the SubjectFormRecord corresponding to the given subject 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

getSubjectFormRecord

SubjectFormRecord getSubjectFormRecord(Type subjectRecordType)
                                       throws OperationFailedException

Gets the SubjectFormRecord corresponding to the given subject record Type.

Parameters:

subjectRecordType - the subject record type

Returns:

the subject form record

Throws:

NullArgumentException - subjectRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subjectRecordType) is false

Compliance:

mandatory - This method must be implemented.