public interface ItemForm extends OsidObjectForm
This is the form for creating and updating Items.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the ItemAdminSession.
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 |
clearLocation()
Removes the location.
|
void |
clearLocationDescription()
Removes the location description.
|
void |
clearPropertyTag()
Removes the property tag.
|
void |
clearSerialNumber()
Removes the serial number.
|
void |
clearStock()
Removes the stock.
|
ItemFormRecord |
getItemFormRecord(Type itemRecordType)
Gets the
ItemFormRecord corresponding to the given item
record Type. |
Metadata |
getItemMetadata()
Gets the metadata for the item.
|
Metadata |
getLocationDescriptionMetadata()
Gets the metadata for location description.
|
Metadata |
getLocationMetadata()
Gets the metadata for location.
|
Metadata |
getPropertyTagMetadata()
Gets the metadata for serial number.
|
Metadata |
getSerialNumberMetadata()
Gets the metadata for serial number.
|
Metadata |
getStockMetadata()
Gets the metadata for stock.
|
void |
setItem(Id itemId)
Sets the item to which this item is a part.
|
void |
setLocation(java.lang.String locationId)
Sets the location.
|
void |
setLocationDescription(java.lang.String location)
Sets the location description.
|
void |
setPropertyTag(java.lang.String property)
Sets the property tag.
|
void |
setSerialNumber(java.lang.String serial)
Sets the serial number.
|
void |
setStock(Id stockId)
Sets the stock
Id. |
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getStockMetadata()
mandatory
- This method must be implemented. void setStock(Id stockId)
Id.
stockId
- the new stockInvalidArgumentException
- stockId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- stockId
is
null
mandatory
- This method must be implemented. void clearStock()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getPropertyTagMetadata()
mandatory
- This method must be implemented. void setPropertyTag(java.lang.String property)
property
- the new property tagInvalidArgumentException
- property
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- property
is
null
mandatory
- This method must be implemented. void clearPropertyTag()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getSerialNumberMetadata()
mandatory
- This method must be implemented. void setSerialNumber(java.lang.String serial)
serial
- the new serial numberInvalidArgumentException
- serial
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- serial
is
null
mandatory
- This method must be implemented. void clearSerialNumber()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getLocationDescriptionMetadata()
mandatory
- This method must be implemented. void setLocationDescription(java.lang.String location)
location
- the new location descriptionInvalidArgumentException
- location
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- location
is
null
mandatory
- This method must be implemented. void clearLocationDescription()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getLocationMetadata()
mandatory
- This method must be implemented. void setLocation(java.lang.String locationId)
locationId
- the new locationInvalidArgumentException
- locationId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- locationId
is
null
mandatory
- This method must be implemented. void clearLocation()
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 parent 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. ItemFormRecord getItemFormRecord(Type itemRecordType) throws OperationFailedException
ItemFormRecord
corresponding to the given item
record Type.
itemRecordType
- an item record typeNullArgumentException
- itemRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(itemRecordType)
is false
mandatory
- This method must be implemented.