com.prosyst.mprm.script.svhistory

Interface StateVariableHistoryManager

All Superinterfaces:

ScriptService

public interface StateVariableHistoryManager
extends ScriptService

The state variable history manager. Used for managing history entries for selected state variables. Can record values of a specified state variable or retrieve stored values from history. It is bound in the scripts under the aliases "historyManager" or "hm"(short).

Field Summary

Fields inherited from interface com.prosyst.mprm.backend.rules.spi.ScriptService

SCRIPT_ALIAS

Method Summary

Modifier and Type	Method and Description
<any>	getStateVariableHistory(java.lang.String deviceType, java.lang.String[] deviceIds, java.lang.String controlUnitType, java.lang.String[] controlUnitIds, java.lang.String[] stateVarIds, HistoryConfiguration historyConfiguration) Get state variable history for a specified set of state variables, control units and devices
<any>	getStateVariableHistory(java.lang.String deviceType, java.lang.String deviceId, java.lang.String controlUnitType, java.lang.String controlUnitId, java.lang.String stateVarId, HistoryConfiguration historyConfiguration) Get state variable history for a specified state variable based on the provided history configuration
void	recordStateVariableHistory(java.lang.String nodePath, boolean wholeSubtree, java.lang.String deviceType, java.lang.String controlUnitType, java.util.Dictionary<java.lang.String,java.lang.Object> stateVarFilter, java.lang.String stateVarId, HistoryConfiguration configuration) Start recording of history for a specified state variable based on the provided history configuration.
void	recordStateVariableHistory(java.lang.String nodePath, boolean wholeSubtree, java.lang.String deviceType, java.lang.String controlUnitType, java.lang.String controlUnitId, java.lang.String stateVarId, HistoryConfiguration configuration) Start recording of history for a specified state variable based on the provided history configuration.
void	recordStateVariableHistory(java.lang.String deviceType, java.lang.String deviceId, java.lang.String controlUnitType, java.util.Dictionary<java.lang.String,java.lang.Object> stateVarFilter, java.lang.String stateVarId, HistoryConfiguration configuration) Start recording of history for a specified state variable based on the provided history configuration.
void	recordStateVariableHistory(java.lang.String deviceType, java.lang.String deviceId, java.lang.String controlUnitType, java.lang.String controlUnitId, java.lang.String stateVarId, HistoryConfiguration configuration) Start recording of history for a specified state variable based on the provided history configuration.
void	stopStateVariableHistory(java.lang.String nodePath, boolean wholeSubtree, java.lang.String deviceType, java.lang.String controlUnitType, java.lang.String controlUnitId, java.lang.String stateVarId) Stop recording of history for a specified state variable, does not clear the current history.
void	stopStateVariableHistory(java.lang.String deviceType, java.lang.String deviceId, java.lang.String controlUnitType, java.lang.String controlUnitId, java.lang.String stateVarId) Stop recording of history for a specified state variable, does not clear the current history.

Methods inherited from interface com.prosyst.mprm.backend.rules.spi.ScriptService

init

Method Detail

recordStateVariableHistory

void recordStateVariableHistory(java.lang.String deviceType,
                                java.lang.String deviceId,
                                java.lang.String controlUnitType,
                                java.lang.String controlUnitId,
                                java.lang.String stateVarId,
                                HistoryConfiguration configuration)
                         throws ManagementException

Start recording of history for a specified state variable based on the provided history configuration. Used when recording for a specified device, control unit and state variable.

Parameters:

deviceType - the device type of the device

deviceId - the device id of the device

controlUnitType - the control unit type

controlUnitId - the control unit id or null, meaning recording will be performed for all control units of the specified type

stateVarId - the state variable id

configuration - the history configuration or null, meaning the only restriction is on the max number of values to record

Throws:

ManagementException

recordStateVariableHistory

void recordStateVariableHistory(java.lang.String nodePath,
                                boolean wholeSubtree,
                                java.lang.String deviceType,
                                java.lang.String controlUnitType,
                                java.lang.String controlUnitId,
                                java.lang.String stateVarId,
                                HistoryConfiguration configuration)
                         throws ManagementException

Start recording of history for a specified state variable based on the provided history configuration. Used when recording for all devices of a certain device type under a specified node path.

Parameters:

nodePath - the node path under which are the devices to listen for events from or null, meaning the root group

wholeSubtree - if recording should be for all devices under the node and in all its subgroups or only for the direct descendants

deviceType - the device type of the device

controlUnitType - the control unit type

controlUnitId - the control unit id or null, meaning recording will be performed for all control units of the specified type

stateVarId - the state variable id

configuration - the history configuration or null, meaning the only restriction is on the max number of values to record

Throws:

ManagementException

recordStateVariableHistory

void recordStateVariableHistory(java.lang.String deviceType,
                                java.lang.String deviceId,
                                java.lang.String controlUnitType,
                                java.util.Dictionary<java.lang.String,java.lang.Object> stateVarFilter,
                                java.lang.String stateVarId,
                                HistoryConfiguration configuration)
                         throws ManagementException

Start recording of history for a specified state variable based on the provided history configuration. Used when recording for a specified device, control unit and state variable.

Parameters:

deviceType - the device type of the device

deviceId - the device id of the device

controlUnitType - the control unit type

stateVarFilter - state variable filter based on concrete values for state variables

stateVarId - the state variable id

configuration - the history configuration or null, meaning the only restriction is on the max number of values to record

Throws:

ManagementException

recordStateVariableHistory

void recordStateVariableHistory(java.lang.String nodePath,
                                boolean wholeSubtree,
                                java.lang.String deviceType,
                                java.lang.String controlUnitType,
                                java.util.Dictionary<java.lang.String,java.lang.Object> stateVarFilter,
                                java.lang.String stateVarId,
                                HistoryConfiguration configuration)
                         throws ManagementException

Start recording of history for a specified state variable based on the provided history configuration. Used when recording for all devices of a certain device type under a specified node path.

Parameters:

nodePath - the node path under which are the devices to listen for events from or null, meaning the root group

wholeSubtree - if recording should be for all devices under the node and in all its subgroups or only for the direct descendants

deviceType - the device type of the device

controlUnitType - the control unit type

stateVarFilter - state variable filter based on concrete values for state variables

stateVarId - the state variable id

configuration - the history configuration or null, meaning the only restriction is on the max number of values to record

Throws:

ManagementException

getStateVariableHistory

<any> getStateVariableHistory(java.lang.String deviceType,
                              java.lang.String deviceId,
                              java.lang.String controlUnitType,
                              java.lang.String controlUnitId,
                              java.lang.String stateVarId,
                              HistoryConfiguration historyConfiguration)
                       throws ManagementException

Get state variable history for a specified state variable based on the provided history configuration

Parameters:

deviceType - the device type of the device

deviceId - the device id of the device

controlUnitType - the control unit type

controlUnitId - the control unit id

stateVarId - the state variable id

historyConfiguration - the history configuration or null, meaning the only restriction is the max number of values

Returns:

an enumerator containing all StateVariableValue objects that are stored for the specified state variable and that are not filtered by the history configuration

Throws:

ManagementException

getStateVariableHistory

<any> getStateVariableHistory(java.lang.String deviceType,
                              java.lang.String[] deviceIds,
                              java.lang.String controlUnitType,
                              java.lang.String[] controlUnitIds,
                              java.lang.String[] stateVarIds,
                              HistoryConfiguration historyConfiguration)
                       throws ManagementException

Get state variable history for a specified set of state variables, control units and devices

Parameters:

deviceType - the device type of the device

deviceIds - non null list of device identifiers

controlUnitType - the control unit type

controlUnitIds - non null list of control unit identifiers

stateVarIds - non null list of state variable identifiers

historyConfiguration - the history configuration or null, meaning the only restriction is the max number of values

Returns:

an enumerator containing all StateVariableValue objects that are stored for the specified state variable and that are not filtered by the history configuration

Throws:

ManagementException

stopStateVariableHistory

void stopStateVariableHistory(java.lang.String deviceType,
                              java.lang.String deviceId,
                              java.lang.String controlUnitType,
                              java.lang.String controlUnitId,
                              java.lang.String stateVarId)
                       throws ManagementException

Stop recording of history for a specified state variable, does not clear the current history. Used when recording for a specified device, control unit and state variable.

Parameters:

deviceType - the device type of the device

deviceId - the device id of the device

controlUnitType - the control unit type

controlUnitId - the control unit id or null, meaning recording will be performed for all control units of the specified type

stateVarId - the state variable id

Throws:

ManagementException

stopStateVariableHistory

void stopStateVariableHistory(java.lang.String nodePath,
                              boolean wholeSubtree,
                              java.lang.String deviceType,
                              java.lang.String controlUnitType,
                              java.lang.String controlUnitId,
                              java.lang.String stateVarId)
                       throws ManagementException

Stop recording of history for a specified state variable, does not clear the current history. Used when recording for all devices of a certain device type under a specified node path.

Parameters:

nodePath - the node path under which are the devices to listen for events from or null, meaning the root group

wholeSubtree - if recording should be for all devices under the node and in all its subgroups or only for the direct descendants

deviceType - the device type of the device

controlUnitType - the control unit type

controlUnitId - the control unit id or null, meaning recording will be performed for all control units of the specified type

stateVarId - the state variable id

Throws:

ManagementException