OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Interfaceosid.ordering.OrderForm
Implementsosid.OsidObjectForm
osid.OsidAggregateableForm
Implemented Byosid.ordering.batch.OrderBatchForm
Used Byosid.ordering.OrderAdminSession
Description

This is the form for creating and updating Order objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the OrderAdminSession . For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetCustomerMetadata
Description

Gets the metadata for a customer.

Returnosid.Metadatametadata for the customer
CompliancemandatoryThis method must be implemented.
MethodsetCustomer
Description

Sets the customer.

Parametersosid.id.IdresourceIdthe new address
ErrorsINVALID_ARGUMENTresourceId is invalid
NO_ACCESSMetadata.isReadOnly() is true
NULL_ARGUMENTresourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearCustomer
Description

Clears the customer.

ErrorsNO_ACCESSMetadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetClosedMetadata
Description

Gets the metadata for the closed status.

Returnosid.Metadatametadata for the customer
CompliancemandatoryThis method must be implemented.
MethodsetClosed
Description

Sets the closed status.

Parametersbooleanclosedthe new closed status
ErrorsINVALID_ARGUMENTclosed is invalid
NO_ACCESSMetadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetOrderFormRecord
Description

Gets the OrderFormRecord corresponding to the given order record Type .

Parametersosid.type.TypeorderRecordTypethe order record type
Returnosid.ordering.records.OrderFormRecordthe order form record
ErrorsNULL_ARGUMENTorderRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(orderRecordType) is false
CompliancemandatoryThis method must be implemented.