Interface Ingredient

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, Subjugateable

public interface Ingredient
extends OsidObject, Subjugateable

An Ingredient represents an item used in a Recipe. Ingredients reference an inventory Stock item that represents a class of Items defined in the Inventory OSID. An Ingreient specifies the quantity required.

Method Summary

Modifier and Type	Method	Description
IngredientRecord	getIngredientRecord(Type ingredientRecordType)	Gets the ingredient record corresponding to the given Ingredient record Type.
BigDecimal	getQuantity()	Gets the quantity of items.
Stock	getStock()	Get the stock.
Id	getStockId()	Gets the Id of the Stock.
Type	getUnitType()	Gets the units of the quantity.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type.

Method Details

getQuantity

BigDecimal getQuantity()

Gets the quantity of items.

Returns:

the quantity

Compliance:

mandatory - This method must be implemented.

getUnitType

Type getUnitType()

Gets the units of the quantity.

Returns:

the unit type

Compliance:

mandatory - This method must be implemented.

getStockId

Id getStockId()

Gets the Id of the Stock.

Returns:

the stock Id

Compliance:

mandatory - This method must be implemented.

getStock

Stock getStock()
        throws OperationFailedException

Get the stock.

Returns:

the stock

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getIngredientRecord

IngredientRecord getIngredientRecord(Type ingredientRecordType)
                              throws OperationFailedException,
PermissionDeniedException

Gets the ingredient record corresponding to the given Ingredient record Type. This method is used to retrieve an object implementing the requested record. The ingredientRecordType may be the Type returned in getRecordType(ingredientRecordType) is true.

Parameters:

ingredientRecordType - the type of ingredient record to retrieve

Returns:

the ingredient record

Throws:

NullArgumentException - ingredientRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(ingredientRecordType) is false

Compliance:

mandatory - This method must be implemented.