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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Methods inherited from interface OsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
void	setRule(Id ruleId)	Sets a rule.

Method Details

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.