Package hec.data.watersupply

Interface IWaterUserContract

All Superinterfaces:
Modifiable, XmlString
All Known Implementing Classes:
JDomWaterUserContractImpl
public interface IWaterUserContract extends Modifiable, XmlString
The Interface WaterUserContract.

  • Field Details

  • Method Details

    • getWaterUserContractRef

      IWaterUserContractRef getWaterUserContractRef()

    • setWaterUserContractRef

      void setWaterUserContractRef(IWaterUserContractRef waterUserContractRef)

    • getContractName

      String getContractName()

    • setContractName

      void setContractName(String contractName)

    • getWaterUser

      IWaterUser getWaterUser()

    • setWaterUser

      void setWaterUser(IWaterUser waterUser)

    • setContractedStorage

      void setContractedStorage(double contractedStorage)
      Sets the contracted storage.
      Parameters:
      contractedStorage - the new contracted storage

    • getContractedStorage

      double getContractedStorage()
      Gets the contracted storage.
      Returns:
      the contracted storage

    • setEffectiveDate

      void setEffectiveDate(Date wsContractEffectiveDate)
      Sets the ws contract effective date.
      Parameters:
      wsContractEffectiveDate - the new ws contract effective date

    • getEffectiveDate

      Date getEffectiveDate()
      Gets the ws contract effective date.
      Returns:
      the ws contract effective date

    • setExpirationDate

      void setExpirationDate(Date wsContractExpirationDate)
      Sets the ws contract expiration date.
      Parameters:
      wsContractExpirationDate - the new ws contract expiration date

    • getExpirationDate

      Date getExpirationDate()
      Gets the ws contract expiration date.
      Returns:
      the ws contract expiration date

    • setInitialUseAllocation

      void setInitialUseAllocation(double initialUseAllocation)
      Sets the initial use allocation.
      Parameters:
      initialUseAllocation - the new initial use allocation

    • getInitialUseAllocation

      double getInitialUseAllocation()
      Gets the initial use allocation.
      Returns:
      the initial use allocation

    • setFutureUseAllocation

      void setFutureUseAllocation(double futureUseAllocation)
      Sets the future use allocation.
      Parameters:
      futureUseAllocation - the new future use allocation

    • getFutureUseAllocation

      double getFutureUseAllocation()
      Gets the future use allocation.
      Returns:
      the future use allocation

    • setFutureUsePercentActivated

      void setFutureUsePercentActivated(double futureUsePercentActivated)
      Sets the future use percent activated.
      Parameters:
      futureUsePercentActivated - the new future use percent activated

    • getFutureUsePercentActivated

      double getFutureUsePercentActivated()
      Gets the future use percent activated.
      Returns:
      the future use percent activated

    • setTotalAllocPercentActivated

      void setTotalAllocPercentActivated(double totalAllocPercentActivated)
      Sets the total alloc percent activated.
      Parameters:
      totalAllocPercentActivated - the new total alloc percent activated

    • getTotalAllocPercentActivated

      double getTotalAllocPercentActivated()
      Gets the total alloc percent activated.
      Returns:
      the total alloc percent activated

    • getContractType

      ILookupType getContractType()

    • setContractType

      void setContractType(ILookupType wsContractType)

    • getContractedStorage

      void getContractedStorage(ParamDouble contractedStorage)

    • getInitialUseAllocation

      void getInitialUseAllocation(ParamDouble initialUseAllocation)

    • getFutureUseAllocation

      void getFutureUseAllocation(ParamDouble futureUseAllocation)

    • getFutureUsePercentActivated

      void getFutureUsePercentActivated(ParamDouble futureUsePercentActivated)

    • getTotalAllocPercentActivated

      void getTotalAllocPercentActivated(ParamDouble totalAllocPercentActivated)

    • setContractedStorage

      void setContractedStorage(ParamDouble contractedStorage)

    • setInitialUseAllocation

      void setInitialUseAllocation(ParamDouble initialUseAllocation)

    • setFutureUseAllocation

      void setFutureUseAllocation(ParamDouble futureUseAllocation)

    • setFutureUsePercentActivated

      void setFutureUsePercentActivated(ParamDouble futureUsePercentActivated)

    • setTotalAllocPercentActivated

      void setTotalAllocPercentActivated(ParamDouble totalAllocPercentActivated)

    • setPumpOut

      void setPumpOut(IWaterSupplyPump waterSupplyPump)
      Sets the location where water is withdrawn from the pool.

    • getPumpOut

      IWaterSupplyPump getPumpOut()
      Gets the pump where water is withdrawn from the pool.

    • getPumpIn

      IWaterSupplyPump getPumpIn()
      Returns the pump where water is pumped into the pool.

    • setPumpIn

      void setPumpIn(IWaterSupplyPump waterSupplyPump)
      Sets the pump where water is pumped into the pool.

    • setPumpOutBelow

      void setPumpOutBelow(IWaterSupplyPump waterSupplyPump)
      Sets the pump where water is pumped out below the pool as supply.

    • getPumpOutBelow

      IWaterSupplyPump getPumpOutBelow()
      Returns the pump where water is pumped out below the pool as supply.

    • getPumpList

      List<IWaterSupplyPump> getPumpList()

    • setPump

      void setPump(IWaterSupplyPump pump, PumpType pumpType)

    • getPump

      IWaterSupplyPump getPump(PumpType pumpType)