org.osid.profile

Interface ProfileEntryForm

All Superinterfaces:

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

All Known Subinterfaces:

ProfileEntryBatchForm

public interface ProfileEntryForm
extends OsidObjectForm

This is the form for creating and updating ProfileEntries. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProfileEntryAdminSession. 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
ProfileEntryFormRecord	getProfileEntryFormRecord(Type profileEntryRecordType) Gets the ProfileEntryFormRecord corresponding to the given profile entry 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

getProfileEntryFormRecord

ProfileEntryFormRecord getProfileEntryFormRecord(Type profileEntryRecordType)
                                                 throws OperationFailedException

Gets the ProfileEntryFormRecord corresponding to the given profile entry record Type.

Parameters:

profileEntryRecordType - the profile entry record type

Returns:

the profile entry form record

Throws:

NullArgumentException - profileEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.