public interface ShipmentForm extends OsidObjectForm, OsidAggregateableForm
This is the form for creating and updating Shipments.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
ShipmentAdminSession.
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 |
clearDate()
Clears the date.
|
void |
clearOrder()
Removes the order.
|
void |
clearSource()
Removes the source.
|
Metadata |
getDateMetadata()
Gets the metadata for the shipment date.
|
Metadata |
getOrderMetadata()
Gets the metadata for an odrer.
|
ShipmentFormRecord |
getShipmentFormRecord(Type shipmentRecordType)
Gets the
ShipmentFormRecord corresponding to the given
shipment record Type. |
Metadata |
getSourceMetadata()
Gets the metadata for a source.
|
void |
setDate(DateTime date)
Sets the date.
|
void |
setOrder(Id orderId)
Sets the order.
|
void |
setSource(Id resourceId)
Sets the source.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getSourceMetadata()
mandatory
- This method must be implemented. void setSource(Id resourceId)
resourceId
- the new sourceInvalidArgumentException
- resourceId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearSource()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getOrderMetadata()
mandatory
- This method must be implemented. void setOrder(Id orderId)
orderId
- the new orderInvalidArgumentException
- orderId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- orderId
is
null
mandatory
- This method must be implemented. void clearOrder()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDateMetadata()
mandatory
- This method must be implemented. void setDate(DateTime date)
date
- the new dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearDate()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ShipmentFormRecord getShipmentFormRecord(Type shipmentRecordType) throws OperationFailedException
ShipmentFormRecord
corresponding to the given
shipment record Type.
shipmentRecordType
- a shipment record typeNullArgumentException
- shipmentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(shipmentRecordType)
is false
mandatory
- This method must be implemented.