com.uc4.communication

Class TimeSettings

java.lang.Object

com.uc4.communication.TimeSettings

public class TimeSettings
extends java.lang.Object

This class represents the Process Flow settings. These settings can be found in the User Interface - Options - Settings - TimeZone/Calendar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeSettings.CalendarView Display setting for calendars.
static class	TimeSettings.FirstWeekOfYear Display setting for the first week of the year.
static class	TimeSettings.TimeFormat Display format of times.

Method Summary

Modifier and Type	Method and Description
TimeSettings.CalendarView	getCalendarView() Returns the calendar view.
TimeSettings.FirstWeekOfYear	getFirstWeekOfYear() Returns the display settings for the first week.
TimeSettings.TimeFormat	getFormat() Returns the display time format.
UC4TimezoneName	getTimezone() The TimeZone that is specified here only serves display reasons (for example, for the Message Wwindow).
boolean	isShowSeconds() Method to know whether to show seconds or not.
void	setCalendarView(TimeSettings.CalendarView calendarView) Sets the calendar view.
void	setFirstWeekOfYear(TimeSettings.FirstWeekOfYear firstWeekOfYear) The definition made here is displayed in Calendar objects but does not influence processing (for example, WEEK_NR).
void	setFormat(TimeSettings.TimeFormat format) Sets the display time format.
void	setShowSeconds(boolean showSeconds) Method to show seconds at places if set to true.
void	setTimezone(UC4TimezoneName timezone) The TimeZone that is specified here only serves display reasons (for example, for the Message Wwindow).

Methods inherited from class java.lang.Object

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

Method Detail

getTimezone

public UC4TimezoneName getTimezone()

The TimeZone that is specified here only serves display reasons (for example, for the Message Wwindow). It does not affect the processing of tasks. Therefore, it does not make a difference who has started the object.

Returns:

Name of the timezone object

setTimezone

public void setTimezone(UC4TimezoneName timezone)

The TimeZone that is specified here only serves display reasons (for example, for the Message Wwindow). It does not affect the processing of tasks. Therefore, it does not make a difference who has started the object.

Parameters:

timezone - Name of the timezone object

getFormat

public TimeSettings.TimeFormat getFormat()

Returns the display time format.

Returns:

Display time format

setFormat

public void setFormat(TimeSettings.TimeFormat format)

Sets the display time format. If you select TimeFormat.FORMAT_DEFAULT in the section Time format, UC4 uses the computer's time format.

Parameters:

format - Display time format

getCalendarView

public TimeSettings.CalendarView getCalendarView()

Returns the calendar view.

Returns:

Calendar View

setCalendarView

public void setCalendarView(TimeSettings.CalendarView calendarView)

Sets the calendar view.

Parameters:

calendarView - Calendar View

getFirstWeekOfYear

public TimeSettings.FirstWeekOfYear getFirstWeekOfYear()

Returns the display settings for the first week.

Returns:

Display setting for First Week of Year

setFirstWeekOfYear

public void setFirstWeekOfYear(TimeSettings.FirstWeekOfYear firstWeekOfYear)

The definition made here is displayed in Calendar objects but does not influence processing (for example, WEEK_NR). CalendarView.USE_CLIENT_SETTINGS will use the value in the UC4 Variable UC_CLIENT_SETTINGS with the key FIRST_WEEK_METHOD.

Parameters:

firstWeekOfYear - Display setting for First Week of Year

isShowSeconds

public boolean isShowSeconds()

Method to know whether to show seconds or not.

Returns:

if true then show seconds else don't show seconds in table.

setShowSeconds

public void setShowSeconds(boolean showSeconds)

Method to show seconds at places if set to true.

Parameters:

showSeconds - if true then show seconds else don't.