OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.OrderForm
Implementsosid.OsidObjectForm
osid.OsidAggregateableForm
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_ARGUMENT resourceId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearCustomer
Description

Clears the customer.

ErrorsNO_ACCESS Metadata.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_ARGUMENT closed is invalid
NO_ACCESS Metadata.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_ARGUMENT orderRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(orderRecordType) is false
CompliancemandatoryThis method must be implemented.