OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.ItemForm
Implementsosid.OsidRelationshipForm
Description

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

MethodgetQuantityMetadata
Description

Gets the metadata for a quantity.

Returnosid.Metadatametadata for the quantity
CompliancemandatoryThis method must be implemented.
MethodsetQuantity
Description

Sets the quantity.

Parameterscardinalquantitythe new quantity
ErrorsINVALID_ARGUMENT quantity is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearQuantity
Description

Clears the quantity.

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

Gets the ItemFormRecord corresponding to the given item record Type.

Parametersosid.type.TypeitemRecordTypethe item record type
Returnosid.ordering.records.ItemFormRecordthe item form record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
CompliancemandatoryThis method must be implemented.