OSID - osid.inventory.shipment.ShipmentForm Service Interface Definition

Interface	osid.inventory.shipment.ShipmentForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidAggregateableForm`
Implemented By	`osid.inventory.shipment.batch.ShipmentBatchForm`
Used By	`osid.inventory.shipment.ShipmentAdminSession`
Description	This is the form for creating and updating `Shipments`. Like all `OsidForms`, 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.
Method	getSourceMetadata
Description	Gets the metadata for a source.
Return	`osid.Metadata`		metadata for the source
Compliance	`mandatory`		This method must be implemented.
Method	setSource
Description	Sets the source.
Parameters	`osid.id.Id`	`resourceId`	the new source
Errors	INVALID_ARGUMENT		`resourceId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSource
Description	Removes the source.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getOrderMetadata
Description	Gets the metadata for an odrer.
Return	`osid.Metadata`		metadata for the order
Compliance	`mandatory`		This method must be implemented.
Method	setOrder
Description	Sets the order.
Parameters	`osid.id.Id`	`orderId`	the new order
Errors	INVALID_ARGUMENT		`orderId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`orderId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOrder
Description	Removes the order.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDateMetadata
Description	Gets the metadata for the shipment date.
Return	`osid.Metadata`		metadata for the date
Compliance	`mandatory`		This method must be implemented.
Method	setDate
Description	Sets the date.
Parameters	`osid.calendaring.DateTime`	`date`	the new date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDate
Description	Clears the date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentFormRecord
Description	Gets the `ShipmentFormRecord` corresponding to the given shipment record `Type`.
Parameters	`osid.type.Type`	`shipmentRecordType`	a shipment record type
Return	`osid.inventory.shipment.records.ShipmentFormRecord`		the shipment form record
Errors	NULL_ARGUMENT		`shipmentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(shipmentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.