Package hec.data.watersupply

Interface IContractWaterSupplyAccounting

All Superinterfaces:
Modifiable
All Known Implementing Classes:
JDomContractWaterSupplyAccounting
public interface IContractWaterSupplyAccounting extends Modifiable
The interface for a contract's water supply accounting split by pump.

  • Method Details

    • getWaterUserContractRef

      IWaterUserContractRef getWaterUserContractRef()
      The contract reference for this accounting.
      Returns:

    • size

      int size()
      The total number of accountings for this contract accounting instance.
      Returns:

    • getAllPumpAccounting

      Map<LocationTemplate,NavigableMap<Date,IWaterSupplyPumpAccounting>> getAllPumpAccounting()
      Returns all of the pump accounting for this contract.
      Returns:

    • getAllPumpAccounting

      Map<LocationTemplate,NavigableMap<Date,IWaterSupplyPumpAccounting>> getAllPumpAccounting(Date startDate, Date endDate)
      Returns all of the pump accounting for this contract windowed to the start and end dates.
      Parameters:
      startDate -
      endDate -
      Returns:

    • getPumpAccounting

      NavigableMap<Date,IWaterSupplyPumpAccounting> getPumpAccounting(LocationTemplate pumpLocRef)
      Returns the accounting for a specified pump location reference.
      Parameters:
      pumpLocRef -
      Returns:

    • getPumpAccounting

      NavigableMap<Date,IWaterSupplyPumpAccounting> getPumpAccounting(LocationTemplate pumpLocRef, Date startDate, Date endDate)
      Returns a windowed accounting for a specified pump location reference using the start and end date.
      Parameters:
      pumpLocRef -
      startDate -
      endDate -
      Returns:

    • mergeAccounting

      void mergeAccounting(LocationTemplate pumpLocRef, NavigableMap<Date,IWaterSupplyPumpAccounting> pumpAccounting, boolean generateModifiedTimeWindow, boolean preserveModifiedData) throws DataObjectException
      Merge the incoming pump data using a store rule. This call assumes that the pump data is for this contract.
      Parameters:
      pumpLocRef -
      pumpAccounting -
      generateModifiedTimeWindow - Controls whether a modified time window is generated indicating data to store to the database.
      Throws:
      DataObjectException

    • mergeAccounting

      void mergeAccounting(IContractWaterSupplyAccounting contractAccounting, boolean generateModifiedTimeWindow, boolean preserveModifiedData) throws DataObjectException
      Merges all of the data from the arg contract accounting into this contract accounting.
      Parameters:
      contractAccounting -
      generateModifiedTimeWindow - Controls whether a modified time window is generated indicating data to store to the database.
      Throws:
      DataObjectException

    • getPumpTimeWindowMap

      Map<LocationTemplate,TimeWindowMap> getPumpTimeWindowMap()
      Returns a mapping of the pump's modified time windows.
      Returns:

    • getTimeWindowMap

      TimeWindowMap getTimeWindowMap(LocationTemplate pumpLocRef)
      Returns the modified time window map for a specific pump.
      Parameters:
      pumpLocRef -
      Returns:

    • clearPumpTimeWindowMaps

      void clearPumpTimeWindowMaps()
      Clears out the modified time windows for the pumps.

    • windowAndLimit

      IContractWaterSupplyAccounting windowAndLimit(Date startTime, Date endTime, boolean headFlag, int rowLimit)
      Returns a limited window of this accounting.
      Parameters:
      startTime -
      endTime -
      rowLimit -
      Returns: