com.uc4.communication

Class ActivitySettings

java.lang.Object

com.uc4.communication.ActivitySettings

public class ActivitySettings
extends Object

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 Type	Method and Description
int	getRefreshDurationMultiplier() Specify the number of seconds that the system must be idle in order to allow refreshing.
int	getRefreshInterval() Returns the refresh interval in case the refresh is set to automatic.
boolean	isAutomatic()
boolean	isOpenCockpitMonitor() Returns true if the Cockpit monitor should be automatically opened.
boolean	isOpenNotificationMonitor() Returns true if the Notification monitor should be automatically opened.
boolean	isOpenProcessFlowMonitor() Returns true if the ProcessFlow monitor should be automatically opened.
boolean	isOpenScheduleMonitor() Returns true if the Schedule monitor should be automatically opened.
void	setAutomatic(boolean automatic) Sets the refresh of the activities to automatic or manual.
void	setOpenCockpitMonitor(boolean openCockpitMonitor) Defines if a Cockpit monitor should be opened automatically.
void	setOpenNotificationMonitor(boolean openNotificationMonitor) Defines if a Notification monitor should be opened automatically.
void	setOpenProcessFlowMonitor(boolean openProcessFlowMonitor) Defines if a ProcessFlow monitor should be opened automatically.
void	setOpenScheduleMonitor(boolean openScheduleMonitor) Defines if a Schedule monitor should be opened automatically.
void	setRefreshDurationMultiplier(int refreshDurationMultiplier) Specify the number of seconds that the system must be idle in order to allow refreshing.
void	setRefreshInterval(int refreshInterval) Sets the refresh interval in seconds for the automatic refresh.

Methods inherited from class java.lang.Object

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

Method Detail

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 -1 if 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()

Returns true if 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 - true if the Notification monitor should be automatically opened, false otherwise

isOpenProcessFlowMonitor

public boolean isOpenProcessFlowMonitor()

Returns true if 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 - true if the ProcessFlow monitor should be automatically opened, false otherwise

isOpenScheduleMonitor

public boolean isOpenScheduleMonitor()

Returns true if 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 - true if the Schedule monitor should be automatically opened, false otherwise

isOpenCockpitMonitor

public boolean isOpenCockpitMonitor()

Returns true if 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?