Methods summary
public
number
|
#
getAmount( )
Amount of item used. The default measurements are by weight, but this may be
the measurement in volume units if AMOUNT_IS_WEIGHT is set to TRUE for this
record. If a liquid it is in liters, if a solid the weight is measured in
kilograms.
Amount of item used. The default measurements are by weight, but this may be
the measurement in volume units if AMOUNT_IS_WEIGHT is set to TRUE for this
record. If a liquid it is in liters, if a solid the weight is measured in
kilograms.
Returns
number
|
public
boolean
|
#
getAmountIsWeight( )
TRUE if the amount measurement is a weight measurement and FALSE if the
amount is a volume measurement. Default value (if not present) is assumed to be
FALSE.
TRUE if the amount measurement is a weight measurement and FALSE if the
amount is a volume measurement. Default value (if not present) is assumed to be
FALSE.
Returns
boolean
|
public
string
|
#
getName( )
Name of the misc item.
Returns
string
|
public
string
|
#
getNotes( )
Detailed notes on the item including usage. May be multiline.
Detailed notes on the item including usage. May be multiline.
Returns
string
|
public
number
|
#
getTime( )
Amount of time the misc was boiled, steeped, mashed, etc in minutes
Amount of time the misc was boiled, steeped, mashed, etc in minutes
Returns
number
|
public
string
|
#
getType( )
May be "Spice", "Fining", "Water Agent", "Herb", "Flavor" or "Other"
May be "Spice", "Fining", "Water Agent", "Herb", "Flavor" or "Other"
Returns
string
|
public
string
|
#
getUse( )
May be "Boil", "Mash", "Primary", "Secondary", "Bottling"
May be "Boil", "Mash", "Primary", "Secondary", "Bottling"
Returns
string
|
public
string
|
#
getUseFor( )
Short description of what the ingredient is used for in text
Short description of what the ingredient is used for in text
Returns
string
|
public
integer
|
#
getVersion( )
Version number of this element. Should be "1" for this version.
Version number of this element. Should be "1" for this version.
Returns
integer
|