jet.api.lc

Class LCRefreshObjInfo

java.lang.Object

jet.api.lc.LCRefreshObjInfo

public class LCRefreshObjInfo
extends java.lang.Object

The definition which represents Refresh object on LC.

Constructor Summary

Constructors

Constructor and Description
LCRefreshObjInfo(JetLCRefreshObj lcr)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName()
int	getRefreshInterval() Specifies the time interval between two auto refreshes.
java.util.Vector<java.lang.String>	getUniqueKeys() Gets the unique key's list.
int	getValueNumber() Specifies the number of records that can be displayed in the data components.
boolean	isEnableAutoRefresh() Sets whether to make the data components that are created on the business view automatically refresh themselves at runtime based on a defined interval.
boolean	isIncrementalFetch() Specifies whether to fetch incremental data only when an auto refresh takes place.
void	setEnableAutoRefresh(boolean enable) Specifies whether to make the data components that are created on the business view automatically refresh themselves at runtime based on a defined interval.
void	setIncrementalFetch(boolean enableIncrementalFetch) Sets whether to fetch incremental data only when an auto refresh takes place.
void	setRefreshInterval(int interval) Sets the time interval between two auto refreshes.
void	setUniqueKeys(java.util.Vector<java.lang.String> uniqueKeys) Sets the unique key's list.
void	setValueNumber(int valueNumber) Sets the number of records that can be displayed in the data components.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LCRefreshObjInfo

public LCRefreshObjInfo(JetLCRefreshObj lcr)

Method Detail

isEnableAutoRefresh

public boolean isEnableAutoRefresh()

Sets whether to make the data components that are created on the business view automatically refresh themselves at runtime based on a defined interval.

Returns:

true if the data components that are created on the business view automatically refresh themselves.

setEnableAutoRefresh

public void setEnableAutoRefresh(boolean enable)

Specifies whether to make the data components that are created on the business view automatically refresh themselves at runtime based on a defined interval.

Parameters:

enable - set true if the data components that are created on the business view automatically refresh themselves.

getRefreshInterval

public int getRefreshInterval()

Specifies the time interval between two auto refreshes. It ranges from 0 to 86400 seconds. Enabled when Enable Auto Refresh is set to true.

Returns:

the interval time in seconds.

See Also:

setEnableAutoRefresh(boolean), isEnableAutoRefresh()

setRefreshInterval

public void setRefreshInterval(int interval)

Sets the time interval between two auto refreshes. It ranges from 0 to 86400 seconds. Enabled when Enable Auto Refresh is set to true.

Parameters:

interval - the interval time in seconds.

See Also:

setEnableAutoRefresh(boolean), isEnableAutoRefresh()

isIncrementalFetch

public boolean isIncrementalFetch()

Specifies whether to fetch incremental data only when an auto refresh takes place. Enabled when Enable Auto Refresh is set to true. This property does not work on crosstabs and real time charts.

Returns:

true if it fetches incremental data only when an auto refresh takes place.

setIncrementalFetch

public void setIncrementalFetch(boolean enableIncrementalFetch)

Sets whether to fetch incremental data only when an auto refresh takes place. Enabled when Enable Auto Refresh is set to true. This property does not work on crosstabs and real time charts.

Parameters:

true - if it fetches incremental data only when an auto refresh takes place.

getUniqueKeys

public java.util.Vector<java.lang.String> getUniqueKeys()

Gets the unique key's list. The unique key used to delete duplicated data from the incremental data filtered by incremental condition. It is meaningful to specify the property when Incremental Fetch is set to true.

Returns:

the unique key's list. The each element of the vector are qualified display name of BV's Group or Detail

See Also:

setIncrementalFetch(boolean), isIncrementalFetch()

setUniqueKeys

public void setUniqueKeys(java.util.Vector<java.lang.String> uniqueKeys)

Sets the unique key's list. The unique key used to delete duplicated data from the incremental data filtered by incremental condition. It is meaningful to specify the property when Incremental Fetch is set to true.

Parameters:

uniqueKeys - the unique key's list. The each element of the vector are qualified display name of BV's Group or Detail

See Also:

setIncrementalFetch(boolean), isIncrementalFetch()

getValueNumber

public int getValueNumber()

Specifies the number of records that can be displayed in the data components. The earliest records will be removed when records exceed the specified number. It is meaningful to specify the property when Incremental Fetch is set to true.

Returns:

the number of records.

See Also:

setIncrementalFetch(boolean), isIncrementalFetch()

setValueNumber

public void setValueNumber(int valueNumber)

Sets the number of records that can be displayed in the data components. The earliest records will be removed when records exceed the specified number. It is meaningful to specify the property when Incremental Fetch is set to true.

Parameters:

valueNumber - the number of records.

See Also:

setIncrementalFetch(boolean), isIncrementalFetch()

getDisplayName

public java.lang.String getDisplayName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object