org.osid.ordering

Interface PriceForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, OsidSubjugateableForm, Suppliable

public interface PriceForm
extends OsidRuleForm, OsidSubjugateableForm

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAmount() Clears the amount.
void	clearDemographic() Clears the demographic.
void	clearMaximumQuantity() Clears the maximum quantity.
void	clearMinimumQuantity() Clears the minimum quantity.
void	clearRecurringInterval() Clears the recurring interval.
Metadata	getAmountMetadata() Gets the metadata for the amount.
Metadata	getDemographicMetadata() Gets the metadata for the demographic.
Metadata	getMaxQuantityMetadata() Gets the metadata for the minimum quantity.
Metadata	getMinQuantityMetadata() Gets the metadata for the minimum quantity.
PriceFormRecord	getPriceFormRecord(Type priceRecordType) Gets the PriceFormRecord corresponding to the given price record Type.
Metadata	getRecurringIntervalMetadata() Gets the metadata for the recurring interval.
void	setAmount(CurrencyRangeTerm[] amount) Sets the amount.
void	setDemographic(Id resourceId) Sets the demographic.
void	setMaximumQuantity(long minQuantity) Sets the maximum quantity.
void	setMinimumQuantity(long minQuantity) Sets the minimum quantity.
void	setRecurringInterval(Duration interval) Sets the recurring interval.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

getMinQuantityMetadata

Metadata getMinQuantityMetadata()

Gets the metadata for the minimum quantity.

Returns:

metadata for the minumim quantity

Compliance:

mandatory - This method must be implemented.

setMinimumQuantity

void setMinimumQuantity(long minQuantity)

Sets the minimum quantity.

Parameters:

minQuantity - the new minumim quantity

Throws:

InvalidArgumentException - minQuantity is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearMinimumQuantity

void clearMinimumQuantity()

Clears the minimum quantity.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getMaxQuantityMetadata

Metadata getMaxQuantityMetadata()

Gets the metadata for the minimum quantity.

Returns:

metadata for the maximum quantity

Compliance:

mandatory - This method must be implemented.

setMaximumQuantity

void setMaximumQuantity(long minQuantity)

Sets the maximum quantity.

Parameters:

minQuantity - the new maximum quantity

Throws:

InvalidArgumentException - maxQuantity is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearMaximumQuantity

void clearMaximumQuantity()

Clears the maximum quantity.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getDemographicMetadata

Metadata getDemographicMetadata()

Gets the metadata for the demographic.

Returns:

metadata for the demographic

Compliance:

mandatory - This method must be implemented.

setDemographic

void setDemographic(Id resourceId)

Sets the demographic.

Parameters:

resourceId - the new demographic

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearDemographic

void clearDemographic()

Clears the demographic.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getAmountMetadata

Metadata getAmountMetadata()

Gets the metadata for the amount.

Returns:

metadata for the amount

Compliance:

mandatory - This method must be implemented.

setAmount

void setAmount(CurrencyRangeTerm[] amount)

Sets the amount.

Parameters:

amount - the new amount

Throws:

InvalidArgumentException - amount is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearAmount

void clearAmount()

Clears the amount.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRecurringIntervalMetadata

Metadata getRecurringIntervalMetadata()

Gets the metadata for the recurring interval.

Returns:

metadata for the recurring interval

Compliance:

mandatory - This method must be implemented.

setRecurringInterval

void setRecurringInterval(Duration interval)

Sets the recurring interval.

Parameters:

interval - the new recurring interval

Throws:

InvalidArgumentException - interval is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearRecurringInterval

void clearRecurringInterval()

Clears the recurring interval.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getPriceFormRecord

PriceFormRecord getPriceFormRecord(Type priceRecordType)
                                   throws OperationFailedException

Gets the PriceFormRecord corresponding to the given price record Type.

Parameters:

priceRecordType - the price record type

Returns:

the price form record

Throws:

NullArgumentException - priceRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(priceRecordType) is false

Compliance:

mandatory - This method must be implemented.