com.prosyst.mprm.admin.svhistory

Interface StateVariableHistoryManager

public interface StateVariableHistoryManager

The state variable history manager interface. Used for managing history entries for selected state variables. Can record values of a specified state variable or retrieve stored values from history.

Author:

Jordan Temelkov, j.temelkov@prosyst.com

Method Summary

Modifier and Type	Method and Description
void	clearStateVariableHistory(java.lang.String nodePath, boolean wholeSubtree, java.lang.String deviceType, java.lang.String controlUnitType, java.lang.String controlUnitId, java.lang.String stateVarId) Clear all history for a specified state variable, does not stop recording if active.
void	clearStateVariableHistory(java.lang.String deviceType, java.lang.String deviceId, java.lang.String controlUnitType, java.lang.String controlUnitId, java.lang.String stateVarId) Clear all history for a specified state variable, does not stop recording if active.
void	delete(java.lang.String configId) Deletes the history request from the history service.
void	exportHistoryConfigs(java.io.OutputStream output) Export the history configurations currently recording.
HistoryConfigurationFactory	getHistoryConfigurationManager() Gets the configuration manager.
MetaTypeProvider	getMetaTypeProvider(java.lang.String pid) Get the meta type provider for the state variable history requests
<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[] stateVarIds, HistoryConfiguration historyConfiguration)
<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
StateVariableHistoryRequest	getStateVariableHistoryRequest(java.lang.String requestId) Get state variable history request for the provided request id
StateVariableHistoryRequest	getStateVariableHistoryRequest(java.lang.String nodePath, boolean wholeSubtree, java.lang.String deviceType, java.lang.String controlUnitType, java.lang.String controlUnitId, java.lang.String stateVarId) Get state variable history request based on the provided node path, device type, control unit type/id and state variable id
StateVariableHistoryRequest	getStateVariableHistoryRequest(java.lang.String deviceType, java.lang.String deviceId, java.lang.String controlUnitType, java.lang.String controlUnitId, java.lang.String stateVarId) Get state variable history request based on the provided device type/id, control unit type/id and state variable id
<any>	getStateVariableHistoryRequests() Get state variable history requests for the current user.
boolean	hasStateVariableHistory(java.lang.String deviceType, java.lang.String deviceId, java.lang.String controlUnitType, java.lang.String controlUnitId, java.lang.String stateVarId) Checks if there is some history for the state variable.
void	importHistoryConfigs(java.io.InputStream input) Import history configurations.
boolean	isRecordingHistory(java.lang.String nodePath, boolean wholeSubtree, java.lang.String deviceType, java.lang.String controlUnitType, java.lang.String controlUnitId, java.lang.String stateVarId) Checks if there is a listener to listen for events for the specified state variable.
boolean	isRecordingHistory(java.lang.String deviceType, java.lang.String deviceId, java.lang.String controlUnitType, java.lang.String controlUnitId, java.lang.String stateVarId) Checks if there is a listener to listen for events for the specified state variable.
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.
void	update(StateVariableHistoryRequest historyRequest) Notifies the history service that a history request should be updated.

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

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

clearStateVariableHistory

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

Clear all history for a specified state variable, does not stop recording if active. 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

clearStateVariableHistory

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

Clear all history for a specified state variable, does not stop recording if active. 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

hasStateVariableHistory

boolean hasStateVariableHistory(java.lang.String deviceType,
                                java.lang.String deviceId,
                                java.lang.String controlUnitType,
                                java.lang.String controlUnitId,
                                java.lang.String stateVarId)
                         throws ManagementException

Checks if there is some history for the state variable. 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

Returns:

true if there are stored history values

Throws:

ManagementException

isRecordingHistory

boolean isRecordingHistory(java.lang.String deviceType,
                           java.lang.String deviceId,
                           java.lang.String controlUnitType,
                           java.lang.String controlUnitId,
                           java.lang.String stateVarId)
                    throws ManagementException

Checks if there is a listener to listen for events for the specified state variable. 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

Returns:

true if the recording is active

Throws:

ManagementException

isRecordingHistory

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

Checks if there is a listener to listen for events for the specified state variable. 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

Returns:

true if the recording is active

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

getStateVariableHistory

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

Throws:

ManagementException

getStateVariableHistoryRequest

StateVariableHistoryRequest getStateVariableHistoryRequest(java.lang.String requestId)
                                                    throws ManagementException

Get state variable history request for the provided request id

Parameters:

requestId - the request id

Returns:

state variable history request for the request id

Throws:

ManagementException

getStateVariableHistoryRequest

StateVariableHistoryRequest getStateVariableHistoryRequest(java.lang.String deviceType,
                                                           java.lang.String deviceId,
                                                           java.lang.String controlUnitType,
                                                           java.lang.String controlUnitId,
                                                           java.lang.String stateVarId)
                                                    throws ManagementException

Get state variable history request based on the provided device type/id, control unit type/id and state variable id

Parameters:

deviceType - the device type

deviceId - the device id

controlUnitType - the control unit type

controlUnitId - the control unit id

stateVarId - the state variable id

Returns:

state variable history request for the provided device type/id, control unit type/id and state variable id

Throws:

ManagementException

getStateVariableHistoryRequest

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

Get state variable history request based on the provided node path, device type, control unit type/id and state variable id

Parameters:

nodePath - the node path

wholeSubtree - if whole subtree was selected

deviceType - the device type

controlUnitType - the control unit type

controlUnitId - the control unit id

stateVarId - the state variable id

Returns:

state variable history request for the provided node path, device type, control unit type/id and state variable id

Throws:

ManagementException

getStateVariableHistoryRequests

<any> getStateVariableHistoryRequests()
                               throws ManagementException

Get state variable history requests for the current user. The StateVariableHistoryRequest objects can be changed at will but for the change to propagate to the backend, the update(StateVariableHistoryRequest) must be called.

Returns:

am enumerator containing the history requests.

Throws:

ManagementException

update

void update(StateVariableHistoryRequest historyRequest)
     throws ManagementException

Notifies the history service that a history request should be updated. Used in combination with getStateVariableHistoryRequests()

Parameters:

historyRequest - the updated history request

Throws:

ManagementException

delete

void delete(java.lang.String configId)
     throws ManagementException

Deletes the history request from the history service. Used in combination with getStateVariableHistoryRequests()

Parameters:

configId - the id of the recording request to be deleted

Throws:

ManagementException

getMetaTypeProvider

MetaTypeProvider getMetaTypeProvider(java.lang.String pid)
                              throws ManagementException

Get the meta type provider for the state variable history requests

Parameters:

pid - one of 'mprm.gdm.svhistory.devicetype' and 'mprm.gdm.svhistory.singledevice' for the two meta types

Returns:

meta type provider for the selected meta type

Throws:

ManagementException

importHistoryConfigs

void importHistoryConfigs(java.io.InputStream input)
                   throws ManagementException

Import history configurations.

Parameters:

input - the history configurations

Throws:

ManagementException

exportHistoryConfigs

void exportHistoryConfigs(java.io.OutputStream output)
                   throws ManagementException

Export the history configurations currently recording.

Parameters:

output -

Throws:

ManagementException

getHistoryConfigurationManager

HistoryConfigurationFactory getHistoryConfigurationManager()

Gets the configuration manager. Use it to create RECORD and GET history configurations.

Returns:

the history configuration manager