public interface EntryForm extends OsidObjectForm, OsidSubjugateableForm
This is the form for creating and updating Entries.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the EntryAdminSession.
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 |
clearItem()
Removes the item.
|
void |
clearModel()
Removes the model.
|
void |
clearQuantity()
Removes the quantity.
|
void |
clearUnitType()
Removes the unit type.
|
EntryFormRecord |
getEntryFormRecord(Type entryRecordType)
Gets the
EntryFormRecord corresponding to the given
entry record Type. |
Metadata |
getItemMetadata()
Gets the metadata for an item.
|
Metadata |
getModelMetadata()
Gets the metadata for a model.
|
Metadata |
getQuantityMetadata()
Gets the metadata for the quantity.
|
Metadata |
getUnitTypeMetadata()
Gets the metadata for the unit type.
|
void |
setItem(Id itemId)
Sets the item.
|
void |
setModel(Id modelId)
Sets the model.
|
void |
setQuantity(java.math.BigDecimal quantity)
Sets the quantity.
|
void |
setUnitType(Type type)
Sets the unit type.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getModelMetadata()
mandatory
- This method must be implemented. void setModel(Id modelId)
modelId
- the new modelInvalidArgumentException
- modelId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- modelId
is
null
mandatory
- This method must be implemented. void clearModel()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getItemMetadata()
mandatory
- This method must be implemented. void setItem(Id itemId)
itemId
- the new itemInvalidArgumentException
- itemId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- itemId
is
null
mandatory
- This method must be implemented. void clearItem()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getQuantityMetadata()
mandatory
- This method must be implemented. void setQuantity(java.math.BigDecimal quantity)
quantity
- the new quantityInvalidArgumentException
- quantity
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearQuantity()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getUnitTypeMetadata()
mandatory
- This method must be implemented. void setUnitType(Type type)
type
- the new unit typeInvalidArgumentException
- type
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- type
is
null
mandatory
- This method must be implemented. void clearUnitType()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. EntryFormRecord getEntryFormRecord(Type entryRecordType) throws OperationFailedException
EntryFormRecord
corresponding to the given
entry record Type.
entryRecordType
- an entry record typeNullArgumentException
- entryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(entryRecordType)
is false
mandatory
- This method must be implemented.