public interface ModelForm extends OsidObjectForm
This is the form for creating and updating Models.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the ModelAdminSession.
For each data element that may be set, metadata may be examined to
provide display hints or data constraints.
Modifier and Type | Method and Description |
---|---|
void |
clearArchetype()
Removes the archetype.
|
void |
clearManufacturer()
Removes the manufacturer.
|
void |
clearNumber()
Removes the model number.
|
Metadata |
getArchetypeMetadata()
Gets the metadata for the archetype.
|
Metadata |
getManufacturerMetadata()
Gets the metadata for the manufacturer.
|
ModelFormRecord |
getModelFormRecord(Type modelRecordType)
Gets the
ModelFormRecord corresponding to the given
model record Type. |
Metadata |
getNumberMetadata()
Gets the metadata for the model number.
|
void |
setArchetype(java.lang.String archetype)
Sets the archetype.
|
void |
setManufacturer(Id resourceId)
Sets the manufacturer.
|
void |
setNumber(java.lang.String number)
Sets the model number.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getManufacturerMetadata()
mandatory
- This method must be implemented. void setManufacturer(Id resourceId)
resourceId
- the new resourceInvalidArgumentException
- resourceId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearManufacturer()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getArchetypeMetadata()
mandatory
- This method must be implemented. void setArchetype(java.lang.String archetype)
archetype
- the new archetypeInvalidArgumentException
- archetype
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- archetype
is
null
mandatory
- This method must be implemented. void clearArchetype()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getNumberMetadata()
mandatory
- This method must be implemented. void setNumber(java.lang.String number)
number
- the new model numberInvalidArgumentException
- number
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- number
is
null
mandatory
- This method must be implemented. void clearNumber()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ModelFormRecord getModelFormRecord(Type modelRecordType) throws OperationFailedException
ModelFormRecord
corresponding to the given
model record Type.
modelRecordType
- a model record typeNullArgumentException
- modelRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(modelRecordType)
is false
mandatory
- This method must be implemented.