OSID Logo
OSID Specifications
ordering package
Version 3.1.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.Metadata metadata for the customer
Compliancemandatory This method must be implemented.
MethodsetCustomer
Description

Sets the customer.

Parametersosid.id.IdresourceId the new address
ErrorsINVALID_ARGUMENT resourceId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceId is null
Compliancemandatory This method must be implemented.
MethodclearCustomer
Description

Clears the customer.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
Compliancemandatory This method must be implemented.
MethodgetClosedMetadata
Description

Gets the metadata for the closed status.

Returnosid.Metadata metadata for the customer
Compliancemandatory This method must be implemented.
MethodsetClosed
Description

Sets the closed status.

Parametersbooleanclosed the new closed status
ErrorsINVALID_ARGUMENT closed is invalid
NO_ACCESS Metadata.isReadOnly() is true
Compliancemandatory This method must be implemented.
MethodgetOrderFormRecord
Description

Gets the OrderFormRecord corresponding to the given order record Type.

Parametersosid.type.TypeorderRecordType the order record type
Returnosid.ordering.records.OrderFormRecord the order form record
ErrorsNULL_ARGUMENT orderRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(orderRecordType) is false
Compliancemandatory This method must be implemented.