org.jscience.economics
Class PotentialResource

java.lang.Object
  extended by org.jscience.economics.PotentialResource
All Implemented Interfaces:
java.io.Serializable, Named
Direct Known Subclasses:
Ingredient, Resource

public class PotentialResource
extends java.lang.Object
implements Named, java.io.Serializable

A class representing a would be resource, or virtual resource, for example oil in the soil that you expect to find or ingredients in a recipie or task.

See Also:
Serialized Form

Constructor Summary
PotentialResource(java.lang.String name, java.lang.String description, Amount amount)
          Creates a new PotentialResource object.
 
Method Summary
 boolean equals(java.lang.Object o)
          DOCUMENT ME!
 Amount getAmount()
          DOCUMENT ME!
 double getDecayTime()
          DOCUMENT ME!
 java.lang.String getDescription()
          DOCUMENT ME!
 int getKind()
          DOCUMENT ME!
 java.lang.String getName()
          DOCUMENT ME!
 void setDecayTime(double decayTime)
          DOCUMENT ME!
 void setKind(int kind)
          DOCUMENT ME!
 void setQuantity(Amount amount)
          DOCUMENT ME!
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PotentialResource

public PotentialResource(java.lang.String name,
                         java.lang.String description,
                         Amount amount)
Creates a new PotentialResource object.

Parameters:
name - DOCUMENT ME!
description - DOCUMENT ME!
amount - DOCUMENT ME!
Method Detail

getName

public java.lang.String getName()
DOCUMENT ME!

Specified by:
getName in interface Named
Returns:
DOCUMENT ME!

getDescription

public java.lang.String getDescription()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getAmount

public Amount getAmount()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setQuantity

public void setQuantity(Amount amount)
DOCUMENT ME!

Parameters:
amount - DOCUMENT ME!
Throws:
java.lang.IllegalArgumentException - DOCUMENT ME!

getDecayTime

public double getDecayTime()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setDecayTime

public void setDecayTime(double decayTime)
DOCUMENT ME!

Parameters:
decayTime - DOCUMENT ME!

getKind

public int getKind()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setKind

public void setKind(int kind)
DOCUMENT ME!

Parameters:
kind - DOCUMENT ME!

equals

public boolean equals(java.lang.Object o)
DOCUMENT ME!

Overrides:
equals in class java.lang.Object
Parameters:
o - DOCUMENT ME!
Returns:
DOCUMENT ME!