OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.PriceForm
Implementsosid.OsidRuleForm
osid.OsidSubjugateableForm
Description

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

MethodgetMinQuantityMetadata
Description

Gets the metadata for the minimum quantity.

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

Sets the minimum quantity.

ParameterscardinalminQuantitythe new minumim quantity
ErrorsINVALID_ARGUMENT minQuantity is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearMinimumQuantity
Description

Clears the minimum quantity.

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

Gets the metadata for the minimum quantity.

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

Sets the maximum quantity.

ParameterscardinalminQuantitythe new maximum quantity
ErrorsINVALID_ARGUMENT maxQuantity is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearMaximumQuantity
Description

Clears the maximum quantity.

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

Gets the metadata for the demographic.

Returnosid.Metadatametadata for the demographic
CompliancemandatoryThis method must be implemented.
MethodsetDemographic
Description

Sets the demographic.

Parametersosid.id.IdresourceIdthe new demographic
ErrorsINVALID_ARGUMENT resourceId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearDemographic
Description

Clears the demographic.

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

Gets the metadata for the amount.

Returnosid.Metadatametadata for the amount
CompliancemandatoryThis method must be implemented.
MethodsetAmount
Description

Sets the amount.

Parametersosid.search.terms.CurrencyRangeTerm[]amountthe new amount
ErrorsINVALID_ARGUMENT amount is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearAmount
Description

Clears the amount.

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

Gets the metadata for the recurring interval.

Returnosid.Metadatametadata for the recurring interval
CompliancemandatoryThis method must be implemented.
MethodsetRecurringInterval
Description

Sets the recurring interval.

Parametersosid.calendaring.Durationintervalthe new recurring interval
ErrorsINVALID_ARGUMENT interval is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearRecurringInterval
Description

Clears the recurring interval.

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

Gets the PriceFormRecord corresponding to the given price record Type.

Parametersosid.type.TypepriceRecordTypethe price record type
Returnosid.ordering.records.PriceFormRecordthe price form record
ErrorsNULL_ARGUMENT priceRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(priceRecordType) is false
CompliancemandatoryThis method must be implemented.