com.isti.trinetwatch.params

Interface ParamHistoryFactory

All Known Implementing Classes:

ParamHistoryFactoryDefault

public interface ParamHistoryFactory

Interface ParamHistoryFactory defines the factory for history for station parameters.

Method Summary

Modifier and Type	Method and Description
ParamHistory	getParamHistory(DynamicParamHolder paramHolder) Get the parameter history.
java.util.List	getParamsListForStation(ParamValues paramValuesObj, Station stationObj, GroupTable agentsTable) Returns a list of dynamic parameters found in the given station's history archive.
java.lang.String	getVersion() Get the version string for the factory.
boolean	isStationHistoryAvail(ParamValues paramValuesObj, Station stationObj) Determines if history for the given station is available.
void	terminate(int maxTerminateDelaySeconds) Terminate the history saving.

Method Detail

getParamHistory

ParamHistory getParamHistory(DynamicParamHolder paramHolder)

Get the parameter history.

Parameters:

paramHolder - the parameter holder.

Returns:

the parameter history.

getParamsListForStation

java.util.List getParamsListForStation(ParamValues paramValuesObj,
                                       Station stationObj,
                                       GroupTable agentsTable)

Returns a list of dynamic parameters found in the given station's history archive. The station's status ("Performance") and usage-level parameters are not included. The given agents-table object will be used to fetch/append the agent objects specified in the parameter entries.

Parameters:

paramValuesObj - object that implements the parameter-values interface.

stationObj - station object for target station.

agentsTable - table of agent objects to use.

Returns:

A list of 'DynamicParamHolder' objects, one for each dynamic parameter found in the station's history archive.

getVersion

java.lang.String getVersion()

Get the version string for the factory.

Returns:

the version string for the factory.

isStationHistoryAvail

boolean isStationHistoryAvail(ParamValues paramValuesObj,
                              Station stationObj)

Determines if history for the given station is available.

Parameters:

paramValuesObj - object that implements the parameter-values interface.

stationObj - station object for target station.

Returns:

true if history for the given station is available; false if not.

terminate

void terminate(int maxTerminateDelaySeconds)

Terminate the history saving.

Parameters:

maxTerminateDelaySeconds - the maximum terminate delay in seconds.