Interface IngredientBatchForm

All Superinterfaces:

Extensible, Identifiable, IngredientForm, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, Suppliable

public interface IngredientBatchForm
extends IngredientForm

This is the form for creating and updating ingredients in bulk. Like all OsidForms, various data elements may be set here for use in the create and update methods in the DirectionBatchAdminSession. 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
Id	getDirectionId()	Gets the Id of the direction if this is a create transaction.
Id	getIngredientId()	Gets the Id of the ingredient to be updated if this is an update transaction.

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 IngredientForm

clearQuantity, clearStock, clearUnitType, getIngredientFormRecord, getQuantityMetadata, getStockMetadata, getUnitTypeMetadata, setQuantity, setStock, setUnitType

Modifier and Type	Method	Description
void	clearQuantity()	Removes the quantity.
void	clearStock()	Removes the stock.
void	clearUnitType()	Removes the unit type.
IngredientFormRecord	getIngredientFormRecord(Type ingredientRecordType)	Gets the IngredientFormRecord corresponding to the given ingredient record Type.
Metadata	getQuantityMetadata()	Gets the metadata for the quantity.
Metadata	getStockMetadata()	Gets the metadata for the stock.
Metadata	getUnitTypeMetadata()	Gets the metadata for the unit type.
void	setQuantity(long quantity)	Sets the quantity.
void	setStock(Id stockId)	Sets the stock.
void	setUnitType(Type unitType)	Sets the unit type.

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.

Method Details

getDirectionId

Id getDirectionId()

Gets the Id of the direction if this is a create transaction.

Returns:

the direction Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getIngredientId

Id getIngredientId()

Gets the Id of the ingredient to be updated if this is an update transaction.

Returns:

the ingredient Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.