Package hec.data.watersupply

Class JDomWaterUserContractImpl

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.data.AbstractJDomDataObject

hec.data.watersupply.JDomWaterUserContractImpl

All Implemented Interfaces:

IWaterUserContract, XmlString, AsciiSerializable, FieldAccessor, Serializable, Cloneable, Comparable, Observer, Modifiable

public class JDomWaterUserContractImpl
extends AbstractJDomDataObject
implements IWaterUserContract

See Also:

• Serialized Form

Field Summary

Fields inherited from class hec.data.AbstractJDomDataObject

DD_MM_MYYYY, DD_MM_MYYYY_HHMM, DD_MM_MYYYY_HHMMZ, MM_MYYYY, UNIT, YYYY

Fields inherited from class hec.lang.NamedType

_description, _ignoreModifiedEvents, _index, _isValid, _modified, _name, defaultDescription, defaultName, DESCRIPTION_CHANGED, NAME_CHANGED, RENAME_EVENT

Fields inherited from interface hec.data.watersupply.IWaterUserContract

CONTRACT_DOCUMENTS, CONTRACT_WATER_USER, CONTRACTED_STORAGE, ELEMENT, FUTURE_USE_ALLOCATION, FUTURE_USE_PERCENT_ACTIVATED, INITIAL_USE_ALLOCATION, PROJECT_LOC, PUMP_IN_LOCATION, PUMP_OUT_BELOW_LOCATION, PUMP_OUT_LOCATION, TOTAL_ALLOC_PERCENT_ACTIVATED, WATER_USER_CONTRACT_REF, WS_CONTRACT_EFFECTIVE_DATE, WS_CONTRACT_EXPIRATION_DATE, WS_CONTRACT_TYPE

Constructor Summary

Constructors

Constructor	Description
JDomWaterUserContractImpl()
JDomWaterUserContractImpl(IWaterUserContract wuc)
JDomWaterUserContractImpl(org.jdom.Element element)

Method Summary

Modifier and Type	Method	Description
void	buildElement(org.jdom.Element element)	Populates the element with data from this object.
boolean	equals(Object obj)
double	getContractedStorage()	Gets the contracted storage.
void	getContractedStorage(ParamDouble paramDouble)
String	getContractName()
ILookupType	getContractType()
Date	getEffectiveDate()	Gets the ws contract effective date.
Timestamp	getEffectiveDateObject()
Date	getExpirationDate()	Gets the ws contract expiration date.
Timestamp	getExpirationDateObject()
double	getFutureUseAllocation()	Gets the future use allocation.
void	getFutureUseAllocation(ParamDouble paramDouble)
double	getFutureUsePercentActivated()	Gets the future use percent activated.
void	getFutureUsePercentActivated(ParamDouble paramDouble)
double	getInitialUseAllocation()	Gets the initial use allocation.
void	getInitialUseAllocation(ParamDouble paramDouble)
JDomLookupTypeImpl	getJDomContractType()
JDomWaterUserContractRef	getJDomWaterUserContractRef()
IWaterSupplyPump	getPump(PumpType pumpType)
IWaterSupplyPump	getPumpIn()	Returns the pump where water is pumped into the pool.
Location	getPumpInLocation()
List<IWaterSupplyPump>	getPumpList()
IWaterSupplyPump	getPumpOut()	Gets the pump where water is withdrawn from the pool.
IWaterSupplyPump	getPumpOutBelow()	Returns the pump where water is pumped out below the pool as supply.
Location	getPumpOutBelowLocation()
Location	getPumpOutLocation()
double	getTotalAllocPercentActivated()	Gets the total alloc percent activated.
void	getTotalAllocPercentActivated(ParamDouble paramDouble)
IWaterUser	getWaterUser()
IWaterUserContractRef	getWaterUserContractRef()
int	hashCode()
void	setContractedStorage(double contractedStorage)	Sets the contracted storage.
void	setContractedStorage(ParamDouble paramDouble)
void	setContractName(String contractName)
void	setContractType(ILookupType wsContractType)
void	setEffectiveDate(Date wsContractEffectiveDate)	Sets the ws contract effective date.
void	setEffectiveDateObject(Timestamp wsContractEffectiveDate)
void	setExpirationDate(Date wsContractExpirationDate)	Sets the ws contract expiration date.
void	setExpirationDateObject(Timestamp wsContractExpirationDate)
void	setFutureUseAllocation(double futureUseAllocation)	Sets the future use allocation.
void	setFutureUseAllocation(ParamDouble paramDouble)
void	setFutureUsePercentActivated(double futureUsePercentActivated)	Sets the future use percent activated.
void	setFutureUsePercentActivated(ParamDouble paramDouble)
void	setInitialUseAllocation(double initialUseAllocation)	Sets the initial use allocation.
void	setInitialUseAllocation(ParamDouble paramDouble)
void	setJDomContractType(JDomLookupTypeImpl wsContractType)
void	setJDomWaterUserContractRef(JDomWaterUserContractRef waterUserContractRef)
void	setPump(IWaterSupplyPump pump, PumpType pumpType)
void	setPumpIn(IWaterSupplyPump waterSupplyPump)	Sets the pump where water is pumped into the pool.
void	setPumpInLocation(Location location)
void	setPumpOut(IWaterSupplyPump waterSupplyPump)	Sets the location where water is withdrawn from the pool.
void	setPumpOutBelow(IWaterSupplyPump waterSupplyPump)	Sets the pump where water is pumped out below the pool as supply.
void	setPumpOutBelowLocation(Location location)
void	setPumpOutLocation(Location location)
void	setTotalAllocPercentActivated(double totalAllocPercentActivated)	Sets the total alloc percent activated.
void	setTotalAllocPercentActivated(ParamDouble paramDouble)
void	setWaterUser(IWaterUser contractWaterUser)
void	setWaterUserContractRef(IWaterUserContractRef waterUserContractRef)

Methods inherited from class hec.data.AbstractJDomDataObject

buildElementOrRemove, camelCaseToLowerUnderbar, getDefaultElementName, getXmlDate, getXmlValue, parseDouble, parseFormattedDouble, parseInt, setXmlDate, setXmlValue, toXmlString

Methods inherited from class hec.lang.NamedType

addModifiableListener, clone, compareTo, fireModifiedStateChanged, getDescription, getDisplayName, getFieldObject, getIgnoreModifiedEvents, getIndex, getName, isModified, isValid, readResolve, removeModifiableListener, rename, set, setDescription, setFieldObject, setIgnoreModifiedEvents, setIndex, setModified, setName, setValid, toString, update, useRecursiveModifiedTest

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface rma.lang.Modifiable

isModified, setModified

Methods inherited from interface hec.data.XmlString

toXmlString

Constructor Details

JDomWaterUserContractImpl

public JDomWaterUserContractImpl()

JDomWaterUserContractImpl

public JDomWaterUserContractImpl(org.jdom.Element element)

JDomWaterUserContractImpl

public JDomWaterUserContractImpl(IWaterUserContract wuc)

Method Details

buildElement

public void buildElement(org.jdom.Element element)

Description copied from class: AbstractJDomDataObject

Populates the element with data from this object.

Specified by:

buildElement in class AbstractJDomDataObject

getContractedStorage

public double getContractedStorage()

Description copied from interface: IWaterUserContract

Gets the contracted storage.

Specified by:

getContractedStorage in interface IWaterUserContract

Returns:

the contracted storage

setContractedStorage

public void setContractedStorage(double contractedStorage)

Description copied from interface: IWaterUserContract

Sets the contracted storage.

Specified by:

setContractedStorage in interface IWaterUserContract

Parameters:

contractedStorage - the new contracted storage

getFutureUseAllocation

public double getFutureUseAllocation()

Description copied from interface: IWaterUserContract

Gets the future use allocation.

Specified by:

getFutureUseAllocation in interface IWaterUserContract

Returns:

the future use allocation

setFutureUseAllocation

public void setFutureUseAllocation(double futureUseAllocation)

Description copied from interface: IWaterUserContract

Sets the future use allocation.

Specified by:

setFutureUseAllocation in interface IWaterUserContract

Parameters:

futureUseAllocation - the new future use allocation

getFutureUsePercentActivated

public double getFutureUsePercentActivated()

Description copied from interface: IWaterUserContract

Gets the future use percent activated.

Specified by:

getFutureUsePercentActivated in interface IWaterUserContract

Returns:

the future use percent activated

setFutureUsePercentActivated

public void setFutureUsePercentActivated(double futureUsePercentActivated)

Description copied from interface: IWaterUserContract

Sets the future use percent activated.

Specified by:

setFutureUsePercentActivated in interface IWaterUserContract

Parameters:

futureUsePercentActivated - the new future use percent activated

getInitialUseAllocation

public double getInitialUseAllocation()

Description copied from interface: IWaterUserContract

Gets the initial use allocation.

Specified by:

getInitialUseAllocation in interface IWaterUserContract

Returns:

the initial use allocation

setInitialUseAllocation

public void setInitialUseAllocation(double initialUseAllocation)

Description copied from interface: IWaterUserContract

Sets the initial use allocation.

Specified by:

setInitialUseAllocation in interface IWaterUserContract

Parameters:

initialUseAllocation - the new initial use allocation

getTotalAllocPercentActivated

public double getTotalAllocPercentActivated()

Description copied from interface: IWaterUserContract

Gets the total alloc percent activated.

Specified by:

getTotalAllocPercentActivated in interface IWaterUserContract

Returns:

the total alloc percent activated

setTotalAllocPercentActivated

public void setTotalAllocPercentActivated(double totalAllocPercentActivated)

Description copied from interface: IWaterUserContract

Sets the total alloc percent activated.

Specified by:

setTotalAllocPercentActivated in interface IWaterUserContract

Parameters:

totalAllocPercentActivated - the new total alloc percent activated

getEffectiveDate

public Date getEffectiveDate()

Description copied from interface: IWaterUserContract

Gets the ws contract effective date.

Specified by:

getEffectiveDate in interface IWaterUserContract

Returns:

the ws contract effective date

setEffectiveDate

public void setEffectiveDate(Date wsContractEffectiveDate)

Description copied from interface: IWaterUserContract

Sets the ws contract effective date.

Specified by:

setEffectiveDate in interface IWaterUserContract

Parameters:

wsContractEffectiveDate - the new ws contract effective date

getEffectiveDateObject

public Timestamp getEffectiveDateObject()

setEffectiveDateObject

public void setEffectiveDateObject(Timestamp wsContractEffectiveDate)

getExpirationDate

public Date getExpirationDate()

Description copied from interface: IWaterUserContract

Gets the ws contract expiration date.

Specified by:

getExpirationDate in interface IWaterUserContract

Returns:

the ws contract expiration date

setExpirationDate

public void setExpirationDate(Date wsContractExpirationDate)

Description copied from interface: IWaterUserContract

Sets the ws contract expiration date.

Specified by:

setExpirationDate in interface IWaterUserContract

Parameters:

wsContractExpirationDate - the new ws contract expiration date

getExpirationDateObject

public Timestamp getExpirationDateObject()

setExpirationDateObject

public void setExpirationDateObject(Timestamp wsContractExpirationDate)

getWaterUserContractRef

public IWaterUserContractRef getWaterUserContractRef()

Specified by:

getWaterUserContractRef in interface IWaterUserContract

setWaterUserContractRef

public void setWaterUserContractRef(IWaterUserContractRef waterUserContractRef)

Specified by:

setWaterUserContractRef in interface IWaterUserContract

getJDomWaterUserContractRef

public JDomWaterUserContractRef getJDomWaterUserContractRef()

setJDomWaterUserContractRef

public void setJDomWaterUserContractRef(JDomWaterUserContractRef waterUserContractRef)

getContractType

public ILookupType getContractType()

Specified by:

getContractType in interface IWaterUserContract

setContractType

public void setContractType(ILookupType wsContractType)

Specified by:

setContractType in interface IWaterUserContract

getJDomContractType

public JDomLookupTypeImpl getJDomContractType()

setJDomContractType

public void setJDomContractType(JDomLookupTypeImpl wsContractType)

setContractName

public void setContractName(String contractName)

Specified by:

setContractName in interface IWaterUserContract

getContractName

public String getContractName()

Specified by:

getContractName in interface IWaterUserContract

setWaterUser

public void setWaterUser(IWaterUser contractWaterUser)

Specified by:

setWaterUser in interface IWaterUserContract

getWaterUser

public IWaterUser getWaterUser()

Specified by:

getWaterUser in interface IWaterUserContract

getContractedStorage

public void getContractedStorage(ParamDouble paramDouble)

Specified by:

getContractedStorage in interface IWaterUserContract

setContractedStorage

public void setContractedStorage(ParamDouble paramDouble)

Specified by:

setContractedStorage in interface IWaterUserContract

getFutureUseAllocation

public void getFutureUseAllocation(ParamDouble paramDouble)

Specified by:

getFutureUseAllocation in interface IWaterUserContract

setFutureUseAllocation

public void setFutureUseAllocation(ParamDouble paramDouble)

Specified by:

setFutureUseAllocation in interface IWaterUserContract

getFutureUsePercentActivated

public void getFutureUsePercentActivated(ParamDouble paramDouble)

Specified by:

getFutureUsePercentActivated in interface IWaterUserContract

setFutureUsePercentActivated

public void setFutureUsePercentActivated(ParamDouble paramDouble)

Specified by:

setFutureUsePercentActivated in interface IWaterUserContract

getInitialUseAllocation

public void getInitialUseAllocation(ParamDouble paramDouble)

Specified by:

getInitialUseAllocation in interface IWaterUserContract

setInitialUseAllocation

public void setInitialUseAllocation(ParamDouble paramDouble)

Specified by:

setInitialUseAllocation in interface IWaterUserContract

getTotalAllocPercentActivated

public void getTotalAllocPercentActivated(ParamDouble paramDouble)

Specified by:

getTotalAllocPercentActivated in interface IWaterUserContract

setTotalAllocPercentActivated

public void setTotalAllocPercentActivated(ParamDouble paramDouble)

Specified by:

setTotalAllocPercentActivated in interface IWaterUserContract

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getPumpOutBelowLocation

public Location getPumpOutBelowLocation()

setPumpOutBelowLocation

public void setPumpOutBelowLocation(Location location)

getPumpOutLocation

public Location getPumpOutLocation()

setPumpOutLocation

public void setPumpOutLocation(Location location)

getPumpInLocation

public Location getPumpInLocation()

setPumpInLocation

public void setPumpInLocation(Location location)

setPumpOut

public void setPumpOut(IWaterSupplyPump waterSupplyPump)

Description copied from interface: IWaterUserContract

Sets the location where water is withdrawn from the pool.

Specified by:

setPumpOut in interface IWaterUserContract

getPumpOut

public IWaterSupplyPump getPumpOut()

Description copied from interface: IWaterUserContract

Gets the pump where water is withdrawn from the pool.

Specified by:

getPumpOut in interface IWaterUserContract

getPumpIn

public IWaterSupplyPump getPumpIn()

Description copied from interface: IWaterUserContract

Returns the pump where water is pumped into the pool.

Specified by:

getPumpIn in interface IWaterUserContract

setPumpIn

public void setPumpIn(IWaterSupplyPump waterSupplyPump)

Description copied from interface: IWaterUserContract

Sets the pump where water is pumped into the pool.

Specified by:

setPumpIn in interface IWaterUserContract

setPumpOutBelow

public void setPumpOutBelow(IWaterSupplyPump waterSupplyPump)

Description copied from interface: IWaterUserContract

Sets the pump where water is pumped out below the pool as supply.

Specified by:

setPumpOutBelow in interface IWaterUserContract

getPumpOutBelow

public IWaterSupplyPump getPumpOutBelow()

Description copied from interface: IWaterUserContract

Returns the pump where water is pumped out below the pool as supply.

Specified by:

getPumpOutBelow in interface IWaterUserContract

getPumpList

public List<IWaterSupplyPump> getPumpList()

Specified by:

getPumpList in interface IWaterUserContract

setPump

public void setPump(IWaterSupplyPump pump,
 PumpType pumpType)

Specified by:

setPump in interface IWaterUserContract

getPump

public IWaterSupplyPump getPump(PumpType pumpType)

Specified by:

getPump in interface IWaterUserContract