org.osid.profile

Interface ProfileItemForm

All Superinterfaces:

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

All Known Subinterfaces:

ProfileItemBatchForm

public interface ProfileItemForm
extends OsidObjectForm

This is the form for creating and updating ProfileItems. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProfileItemAdminSession. 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
ProfileItemFormRecord	getProfileItemFormRecord(Type profileItemRecordType) Gets the ProfileItemFormRecord corresponding to the given profile item 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

getProfileItemFormRecord

ProfileItemFormRecord getProfileItemFormRecord(Type profileItemRecordType)
                                               throws OperationFailedException

Gets the ProfileItemFormRecord corresponding to the given profile item record Type.

Parameters:

profileItemRecordType - the profile item record type

Returns:

the profile item form record

Throws:

NullArgumentException - profileItemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileItemRecordType) is false

Compliance:

mandatory - This method must be implemented.