Interface ProfileItemForm
- All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable
- All Known Subinterfaces:
ProfileItemBatchForm
This is the form for creating and updating ProfileItems. Like
all OsidForms, 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.
Like all OsidForms, ProfileItemForm is stateful and
must not be accessed by multiple processing threads.
-
Method Summary
Modifier and TypeMethodDescriptiongetProfileItemFormRecord(Type profileItemRecordType) Gets theProfileItemFormRecordcorresponding to the given profile item recordType.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeMethods inherited from interface Identifiable
getId, isCurrentMethods inherited from interface OsidExtensibleForm
getRequiredRecordTypesMethods inherited from interface OsidForm
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocaleMethods inherited from interface OsidObjectForm
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
-
Method Details
-
getProfileItemFormRecord
ProfileItemFormRecord getProfileItemFormRecord(Type profileItemRecordType) throws OperationFailedException Gets theProfileItemFormRecordcorresponding to the given profile item recordType.- Parameters:
profileItemRecordType- the profile item record type- Returns:
- the profile item form record
- Throws:
NullArgumentException-profileItemRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(profileItemRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-