OSID Logo
OSID Specifications
inventory shipment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.shipment.ShipmentForm
Implementsosid.OsidObjectForm
osid.OsidAggregateableForm
Description

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.

MethodgetSourceMetadata
Description

Gets the metadata for a source.

Returnosid.Metadatametadata for the source
CompliancemandatoryThis method must be implemented.
MethodsetSource
Description

Sets the source.

Parametersosid.id.IdresourceIdthe new source
ErrorsINVALID_ARGUMENT resourceId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearSource
Description

Removes the source.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetOrderMetadata
Description

Gets the metadata for an odrer.

Returnosid.Metadatametadata for the order
CompliancemandatoryThis method must be implemented.
MethodsetOrder
Description

Sets the order.

Parametersosid.id.IdorderIdthe new order
ErrorsINVALID_ARGUMENT orderId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT orderId is null
CompliancemandatoryThis method must be implemented.
MethodclearOrder
Description

Removes the order.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetDateMetadata
Description

Gets the metadata for the shipment date.

Returnosid.Metadatametadata for the date
CompliancemandatoryThis method must be implemented.
MethodsetDate
Description

Sets the date.

Parametersosid.calendaring.DateTimedatethe new date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearDate
Description

Clears the date.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetShipmentFormRecord
Description

Gets the ShipmentFormRecord corresponding to the given shipment record Type.

Parametersosid.type.TypeshipmentRecordTypea shipment record type
Returnosid.inventory.shipment.records.ShipmentFormRecordthe shipment form record
ErrorsNULL_ARGUMENT shipmentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(shipmentRecordType) is false
CompliancemandatoryThis method must be implemented.