Package hec.data.project

Interface IProject

All Superinterfaces:
ILocationAssociation, Modifiable, XmlString
All Known Implementing Classes:
JDomProjectImpl
public interface IProject extends XmlString, Modifiable, ILocationAssociation
The interface to a project.

  • Field Details

  • Method Details

    • getProjectId

      String getProjectId()
      Returns the concatenated base location id - sub location id for this project.

    • getProjectOfficeId

      String getProjectOfficeId()
      Returns the office id that owns this project.

    • getProjectTimeZone

      TimeZone getProjectTimeZone()
      Returns the office id that owns this project.

    • getLocation

      Location getLocation()
      Returns the location for this project. Can be modified by reference.
      Specified by:
      getLocation in interface ILocationAssociation
      Returns:

    • setLocation

      void setLocation(Location location)
      Specified by:
      setLocation in interface ILocationAssociation

    • getAuthorizingLaw

      String getAuthorizingLaw()
      Returns the law authorizing this project.

    • setAuthorizingLaw

      void setAuthorizingLaw(String authorizingLaw)
      Sets the law authorizing this project.
      Parameters:
      authorizingLaw -

    • getFederalCost

      double getFederalCost()
      Returns the federal cost of this project.
      Returns:

    • getFederalCost

      void getFederalCost(ParamDouble value)

    • setFederalCost

      void setFederalCost(double cost)
      Sets the federal cost for this project.
      Parameters:
      cost -

    • getNonFederalCost

      double getNonFederalCost()
      Returns the non federal cost of this project.
      Returns:

    • getNonFederalCost

      void getNonFederalCost(ParamDouble value)

    • setNonFederalCost

      void setNonFederalCost(double cost)
      Sets the non federal cost of this project.
      Parameters:
      cost -

    • getCostYear

      long getCostYear()
      Returns the date of the major cost of the project.
      Returns:
      a java ms utc time for the year.

    • getCostYearObject

      Timestamp getCostYearObject()
      Returns the date of the major cost of the project. Used for database serialization
      Returns:
      timestamp for the year.

    • setCostYear

      void setCostYear(long time)
      Sets the cost year of this project.
      Parameters:
      time - a java ms utc time for the year.

    • getFederalOandMCost

      double getFederalOandMCost()
      Returns the federal operations and maintenance cost for this project.
      Returns:

    • getFederalOandMCost

      void getFederalOandMCost(ParamDouble value)

    • setFederalOandMCost

      void setFederalOandMCost(double cost)
      Sets the federal operations and maintenance cost for this project.
      Parameters:
      cost -

    • getNonFederalOandMCost

      double getNonFederalOandMCost()
      Returns the non federal operations and maintenance cost for this project.
      Returns:

    • getNonFederalOandMCost

      void getNonFederalOandMCost(ParamDouble value)

    • setNonFederalOandMCost

      void setNonFederalOandMCost(double cost)
      Sets the non federal operations and maintenance cost for this project.
      Parameters:
      cost -

    • getRemarks

      String getRemarks()
      Returns the general remarks for this project.
      Returns:

    • setRemarks

      void setRemarks(String remarks)
      Sets the general remarks for this project.
      Parameters:
      remarks -

    • getProjectOwner

      String getProjectOwner()
      Returns the assigned owner of this project.
      Returns:

    • setProjectOwner

      void setProjectOwner(String owner)
      Sets the assigned owner of this project.
      Parameters:
      owner -

    • getPumpbackLocation

      Location getPumpbackLocation()
      Returns by reference the location associated with water pumped back into ' this project, can be null.
      Returns:

    • getNearGageLocation

      Location getNearGageLocation()
      Returns by reference the location associated with the near gage for this project.
      Returns:

    • getBankFullCapacityDescription

      String getBankFullCapacityDescription()

    • getDownstreamUrbanDescription

      String getDownstreamUrbanDescription()

    • getHydropowerDescription

      String getHydropowerDescription()

    • getSedimentationDescription

      String getSedimentationDescription()

    • getYieldTimeFrameStart

      long getYieldTimeFrameStart()

    • getYieldTimeFrameStartTimestamp

      Timestamp getYieldTimeFrameStartTimestamp()

    • getYieldTimeFrameEnd

      long getYieldTimeFrameEnd()

    • getYieldTimeFrameEndTimestamp

      Timestamp getYieldTimeFrameEndTimestamp()

    • setSedimentationDescription

      void setSedimentationDescription(String text)

    • setBankFullCapacityDescription

      void setBankFullCapacityDescription(String text)

    • setHydropowerDescription

      void setHydropowerDescription(String text)

    • setDownstreamUrbanDescription

      void setDownstreamUrbanDescription(String text)

    • setYieldTimeFrameStart

      void setYieldTimeFrameStart(long timeInMillis)

    • setYieldTimeFrameEnd

      void setYieldTimeFrameEnd(long timeInMillis)

    • setPumpbackLocation

      void setPumpbackLocation(Location location)

    • setNearGageLocation

      void setNearGageLocation(Location location)

    • getFederalCostUnit

      String getFederalCostUnit()

    • getFederalOandMCostUnit

      String getFederalOandMCostUnit()

    • getNonFederalCostUnit

      String getNonFederalCostUnit()

    • getNonFederalOandMCostUnit

      String getNonFederalOandMCostUnit()