OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.ProductForm
Implementsosid.OsidObjectForm
Description

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

MethodgetCodeMetadata
Description

Gets the metadata for the code.

Returnosid.Metadatametadata for the code
CompliancemandatoryThis method must be implemented.
MethodsetCode
Description

Sets the code.

Parametersstringcodethe new code
ErrorsINVALID_ARGUMENT code is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT code is null
CompliancemandatoryThis method must be implemented.
MethodclearCode
Description

Clears the code.

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

Gets the metadata for the price schedules.

Returnosid.Metadatametadata for the price schedules
CompliancemandatoryThis method must be implemented.
MethodsetPriceSchedules
Description

Sets the price schedules.

Parametersosid.id.Id[]priceScheduleidsthe new price schedules
ErrorsINVALID_ARGUMENT priceScheduleIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT priceScheduleIds is null
CompliancemandatoryThis method must be implemented.
MethodclearPriceSchedules
Description

Clears the price schedules.

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

Gets the metadata for the availability.

Returnosid.Metadatametadata for the availability
CompliancemandatoryThis method must be implemented.
MethodsetAvailability
Description

Sets the availability.

Parameterscardinalavailabilitythe new availability
ErrorsINVALID_ARGUMENT availability is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearAvailability
Description

Clears the availability.

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

Gets the ProductFormRecord corresponding to the given product record Type.

Parametersosid.type.TypeproductRecordTypethe product record type
Returnosid.ordering.records.ProductFormRecordthe product form record
ErrorsNULL_ARGUMENT productRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(productRecordType) is false
CompliancemandatoryThis method must be implemented.