Package com.uc4.communication
Class ActivitySettings
java.lang.Object
com.uc4.communication.ActivitySettings
This class represents the settings for the activity refresh.
These settings can be found in the User Interface - Options - Settings - Activity Refresh
-
Method Summary
Modifier and TypeMethodDescriptionintSpecify the number of seconds that the system must be idle in order to allow refreshing.intReturns the refresh interval in case the refresh is set to automatic.booleanbooleanReturnstrueif the Cockpit monitor should be automatically opened.booleanReturnstrueif the Notification monitor should be automatically opened.booleanReturnstrueif the ProcessFlow monitor should be automatically opened.booleanReturnstrueif the Schedule monitor should be automatically opened.voidsetAutomatic(boolean automatic) Sets the refresh of the activities to automatic or manual.voidsetOpenCockpitMonitor(boolean openCockpitMonitor) Defines if a Cockpit monitor should be opened automatically.voidsetOpenNotificationMonitor(boolean openNotificationMonitor) Defines if a Notification monitor should be opened automatically.voidsetOpenProcessFlowMonitor(boolean openProcessFlowMonitor) Defines if a ProcessFlow monitor should be opened automatically.voidsetOpenScheduleMonitor(boolean openScheduleMonitor) Defines if a Schedule monitor should be opened automatically.voidsetRefreshDurationMultiplier(int refreshDurationMultiplier) Specify the number of seconds that the system must be idle in order to allow refreshing.voidsetRefreshInterval(int refreshInterval) Sets the refresh interval in seconds for the automatic refresh.
-
Method Details
-
isAutomatic
public boolean isAutomatic()- Returns:
- true if refresh is automatic, false if manual
-
setAutomatic
public void setAutomatic(boolean automatic) Sets the refresh of the activities to automatic or manual.- Parameters:
automatic- true if refresh should be automatic, false if manual
-
getRefreshInterval
public int getRefreshInterval()Returns the refresh interval in case the refresh is set to automatic.- Returns:
- Interval in seconds or
-1if manual refresh is enabled
-
setRefreshInterval
public void setRefreshInterval(int refreshInterval) Sets the refresh interval in seconds for the automatic refresh.- Parameters:
refreshInterval- Interval in seconds between 1 and 999
-
getRefreshDurationMultiplier
public int getRefreshDurationMultiplier()Specify the number of seconds that the system must be idle in order to allow refreshing. This interval is influenced by the duration of the previous refreshing time as refreshing can take some time when there are many tasks in the Activity Window - for example when a ProcessFlow is being processed. As a result, the interval until the next window is refreshed gets longer. This setting serves performance improving purposes.- Returns:
- Refresh duration
-
setRefreshDurationMultiplier
public void setRefreshDurationMultiplier(int refreshDurationMultiplier) Specify the number of seconds that the system must be idle in order to allow refreshing. This interval is influenced by the duration of the previous refreshing time as refreshing can take some time when there are many tasks in the Activity Window - for example when a ProcessFlow is being processed. As a result, the interval until the next window is refreshed gets longer. This setting serves performance improving purposes.- Parameters:
refreshDurationMultiplier- Refresh duration
-
isOpenNotificationMonitor
public boolean isOpenNotificationMonitor()Returnstrueif the Notification monitor should be automatically opened.- Returns:
- Open Notification monitor?
-
setOpenNotificationMonitor
public void setOpenNotificationMonitor(boolean openNotificationMonitor) Defines if a Notification monitor should be opened automatically.- Parameters:
openNotificationMonitor-trueif the Notification monitor should be automatically opened, false otherwise
-
isOpenProcessFlowMonitor
public boolean isOpenProcessFlowMonitor()Returnstrueif the ProcessFlow monitor should be automatically opened.- Returns:
- Open ProcessFlow monitor?
-
setOpenProcessFlowMonitor
public void setOpenProcessFlowMonitor(boolean openProcessFlowMonitor) Defines if a ProcessFlow monitor should be opened automatically.- Parameters:
openProcessFlowMonitor-trueif the ProcessFlow monitor should be automatically opened, false otherwise
-
isOpenScheduleMonitor
public boolean isOpenScheduleMonitor()Returnstrueif the Schedule monitor should be automatically opened.- Returns:
- Open Schedule monitor?
-
setOpenScheduleMonitor
public void setOpenScheduleMonitor(boolean openScheduleMonitor) Defines if a Schedule monitor should be opened automatically.- Parameters:
openScheduleMonitor-trueif the Schedule monitor should be automatically opened, false otherwise
-
isOpenCockpitMonitor
public boolean isOpenCockpitMonitor()Returnstrueif the Cockpit monitor should be automatically opened.- Returns:
- Open Cockpit monitor?
-
setOpenCockpitMonitor
public void setOpenCockpitMonitor(boolean openCockpitMonitor) Defines if a Cockpit monitor should be opened automatically.- Parameters:
openCockpitMonitor- Open Cockpit monitor?
-