org.starhope.appius.game.inventory
Interface AbstractItem

All Superinterfaces:

com.whirlycott.cache.Cacheable, CTime, DataRecord, HasSubversionRevision

All Known Implementing Classes:

GenericItemReference

public interface AbstractItem
extends DataRecord

Author:

brpocock@star-hope.org

Method Summary

Collection<ItemCollection>	getCollections()
Currency	getCurrency()
String	getDescription() Get the user-visible description of the item
int	getItemID()
BigDecimal	getPrice()
RarityRating	getRarity()
String	getTitle()
void	setItemID(int itemID1)
void	setPrice(Currency currency, BigDecimal price)
void	setTitle(String title1)
org.json.JSONObject	toJSON() WRITEME: document this method (brpocock@star-hope.org, Aug 27, 2009)

Methods inherited from interface org.starhope.appius.util.DataRecord

checkStale, getCacheableID, getCacheableIdent, getRecordLoader, isBeingLoaded, markAsLoaded, markAsSaved, setRecordLoader

Methods inherited from interface org.starhope.appius.util.CTime

getTimeLastChanged, getTimeLastSaved

Methods inherited from interface org.starhope.util.HasSubversionRevision

getSubversionRevision

Methods inherited from interface com.whirlycott.cache.Cacheable

onRemove, onRetrieve, onStore

Method Detail

getDescription

String getDescription()

Get the user-visible description of the item

Returns:

the database description of the item

getItemID

int getItemID()

Returns:

the itemID

getPrice

BigDecimal getPrice()

Returns:

the price

getCurrency

Currency getCurrency()

Returns:

the currency measuring the price

getTitle

String getTitle()

Returns:

the title

getCollections

Collection<ItemCollection> getCollections()

Returns:

the set of collections of which this item may be a part

getRarity

RarityRating getRarity()

Returns:

the rarity rating of this item

setItemID

void setItemID(int itemID1)

Parameters:

itemID1 - the itemID to set

setPrice

void setPrice(Currency currency,
              BigDecimal price)

Parameters:

currency - the currency units

price - the price to set

setTitle

void setTitle(String title1)

Parameters:

title1 - the title to set

toJSON

org.json.JSONObject toJSON()

WRITEME: document this method (brpocock@star-hope.org, Aug 27, 2009)

Returns:

WRITEME