com.isti.trinetwatch.params
Interface ParamHistory

All Known Implementing Classes:
ParamHistoryTable, ParamHistoryVector

public interface ParamHistory

Interface ParamHistory defines the history for station parameters.


Method Summary
 void add(DynamicParamHolder paramHolder, Station stationObj, DynamicParameter dParameter, long timeLastChanged, long timeLastReceived, long minTime)
          Adds the item to the history.
 java.util.Vector getHistoryVector(long startTime, long endTime)
          Returns a new Vector containing 'ValueTimeBlock' objects with timestamps in the specified range.
 boolean isHistoryEnabled()
          Determines if the history is enabled.
 

Method Detail

add

public void add(DynamicParamHolder paramHolder,
                Station stationObj,
                DynamicParameter dParameter,
                long timeLastChanged,
                long timeLastReceived,
                long minTime)
Adds the item to the history.

Parameters:
paramHolder - the parameter holder.
stationObj - the station object.
dParameter - the dynamic parameter.
timeLastChanged - the time last changed (seconds since 1/1/1970).
timeLastReceived - the time last received (seconds since 1/1/1970).
minTime - the minimum time (seconds since 1/1/1970).

getHistoryVector

public java.util.Vector getHistoryVector(long startTime,
                                         long endTime)
Returns a new Vector containing 'ValueTimeBlock' objects with timestamps in the specified range. The start and end time parameter values are in seconds since 1/1/1970, and are "inclusive".

Parameters:
startTime - the start time for the range, or 0 for the beginning of the history.
endTime - the end time for the range, or 0 for the end of the history.
Returns:
A Vector of 'ValueTimeBlock' objects with timestamps in the specified range, an empty Vector if no matching objects were found, or null if no history objects are available.

isHistoryEnabled

public boolean isHistoryEnabled()
Determines if the history is enabled.

Returns:
true if enabled, false otherwise.