com.prosyst.mprm.admin.svhistory

Interface StateVariableHistoryRequest

public interface StateVariableHistoryRequest

The state variable history request interface. Used for retrieving/updating information for the state variable history requests that are generating history records.

Author:

Jordan Temelkov, j.temelkov@prosyst.com

Method Summary

Modifier and Type	Method and Description
java.lang.String	getControlUnitId() Get the control unit id, is null if the history request is made for all components of a selected control unit type, or a state variable filter is used
java.lang.String	getControlUnitType() Get the control unit type
java.lang.String	getDeviceId() Get the device id, null is returned when the state variable history request is made for a group and not a specific device
java.lang.String	getDeviceType() Get the device type
HistoryConfiguration	getHistoryConfiguration() Get the history configuration
java.lang.String	getNodePath() Get the node path, null is returned when the state variable history request is made for a concrete device
java.lang.String	getRequestId() Get the request id
java.lang.String	getStateVarFilter() Get the state variables filter, is null if the history request is made for all components of a selected control unit type or a specific control unit id is used
java.lang.String	getStateVarId() Get the state variable id
boolean	isWholeSubtree() Check if the history request is generating history data for all devices in the group hierarchy or just the current group
void	setControlUnitId(java.lang.String controlUnitId) Set the control unit id
void	setControlUnitType(java.lang.String controlUnitType) Set the control unit type
void	setDeviceId(java.lang.String deviceId) Set the device id
void	setDeviceType(java.lang.String deviceType) Set the device type
void	setNodePath(java.lang.String nodePath) Set the node path
void	setStateVarFilter(java.lang.String stateVarFilter) Set the state variables filter
void	setStateVarId(java.lang.String stateVarId) Set the state variable id
void	setWholeSubtree(boolean wholeSubtree) Set if the whole tree hierarchy of the current group or only the current group should be used in the history data generation

Method Detail

getRequestId

java.lang.String getRequestId()

Get the request id

Returns:

the request id

getNodePath

java.lang.String getNodePath()

Get the node path, null is returned when the state variable history request is made for a concrete device

Returns:

the node path

setNodePath

void setNodePath(java.lang.String nodePath)

Set the node path

Parameters:

nodePath - the new node path

isWholeSubtree

boolean isWholeSubtree()

Check if the history request is generating history data for all devices in the group hierarchy or just the current group

Returns:

if the whole subtree is generating history data

setWholeSubtree

void setWholeSubtree(boolean wholeSubtree)

Set if the whole tree hierarchy of the current group or only the current group should be used in the history data generation

Parameters:

wholeSubtree - if the whole subtree should be generating history data

getDeviceType

java.lang.String getDeviceType()

Get the device type

Returns:

the device type

setDeviceType

void setDeviceType(java.lang.String deviceType)

Set the device type

Parameters:

deviceType - the new device type

getDeviceId

java.lang.String getDeviceId()

Get the device id, null is returned when the state variable history request is made for a group and not a specific device

Returns:

the device id

setDeviceId

void setDeviceId(java.lang.String deviceId)

Set the device id

Parameters:

deviceId - the new device id

getControlUnitType

java.lang.String getControlUnitType()

Get the control unit type

Returns:

the control unit type

setControlUnitType

void setControlUnitType(java.lang.String controlUnitType)

Set the control unit type

Parameters:

controlUnitType - the new control unit type

getControlUnitId

java.lang.String getControlUnitId()

Get the control unit id, is null if the history request is made for all components of a selected control unit type, or a state variable filter is used

Returns:

the control unit id

setControlUnitId

void setControlUnitId(java.lang.String controlUnitId)

Set the control unit id

Parameters:

controlUnitId - the new control unit id

getStateVarFilter

java.lang.String getStateVarFilter()

Get the state variables filter, is null if the history request is made for all components of a selected control unit type or a specific control unit id is used

Returns:

the state variables filter

setStateVarFilter

void setStateVarFilter(java.lang.String stateVarFilter)

Set the state variables filter

Parameters:

stateVarFilter - the new state variables filter

getStateVarId

java.lang.String getStateVarId()

Get the state variable id

Returns:

the state variable id

setStateVarId

void setStateVarId(java.lang.String stateVarId)

Set the state variable id

Parameters:

stateVarId - the new state variable id

getHistoryConfiguration

HistoryConfiguration getHistoryConfiguration()

Get the history configuration

Returns:

the history configuration