com.uc4.api.objects

Class TimeZoneAttributes.TimeChangeRule

java.lang.Object

com.uc4.api.objects.TimeZoneAttributes.TimeChangeRule

Enclosing class:

TimeZoneAttributes

public static class TimeZoneAttributes.TimeChangeRule
extends java.lang.Object

Defines the point in time for a time change.

Method Summary

Modifier and Type	Method and Description
int	getHour() Gets the hour of the day at which the time change takes place.
int	getMinute() Gets the number of minutes after the hour at which the time change takes place.
int	getMonth() Gets the month of a particular year in which the time change is made.
int	getNDay() Gets the predetermined weekday(for example, the 2nd or 3rd Wednesday) of the month the time change take place.
int	getWeekday() Gets the weekday on which the time change is made.
void	setHour(int hour) Sets the hour of the day at which the time change takes place. Allowed values: 0 to 23
void	setMinute(int minute) Gets the number of minutes after the hour at which the time change takes place. Allowed values: 0 to 59
void	setMonth(int month) Sets the month of a particular year in which the time change is made.
void	setNDay(int nDay) Sets the predetermined weekday(for example, the 2nd or 3rd Wednesday) of the month the time change take place.
void	setWeekday(int day) Sets the weekday on which the time change is made.

Methods inherited from class java.lang.Object

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

Method Detail

getMonth

public int getMonth()

Gets the month of a particular year in which the time change is made.

Returns:

month

setMonth

public void setMonth(int month)

Sets the month of a particular year in which the time change is made. Allowed values: 1 to 12

Parameters:

month - of the time change

getWeekday

public int getWeekday()

Gets the weekday on which the time change is made. The week begins with Monday (= 1) and ends on Sunday (= 7).

1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday
7 = Sunday

Returns:

weekday of the time change

setWeekday

public void setWeekday(int day)

Sets the weekday on which the time change is made. The week begins with Monday (= 1) and ends on Sunday (= 7).

Allowed values: 1 to 7
* 1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday
7 = Sunday

Parameters:

day - weekday of the time change

getNDay

public int getNDay()

Gets the predetermined weekday(for example, the 2nd or 3rd Wednesday) of the month the time change take place. A setting of '5' always denotes the last possible defined weekday, even if the month is made up of only four weeks.

Returns:

occurrence of the weekday on which the time change take place

setNDay

public void setNDay(int nDay)

Sets the predetermined weekday(for example, the 2nd or 3rd Wednesday) of the month the time change take place. A setting of '5' always denotes the last possible defined weekday, even if the month is made up of only four weeks.
Allowed values: 1 to 5;

Parameters:

nDay - occurrence of the weekday on which the time change take place

getHour

public int getHour()

Gets the hour of the day at which the time change takes place.

Returns:

hour at with the time change take place

setHour

public void setHour(int hour)

Sets the hour of the day at which the time change takes place.
Allowed values: 0 to 23

Parameters:

hour - at with the time change take place

getMinute

public int getMinute()

Gets the number of minutes after the hour at which the time change takes place.

Returns:

minutes

setMinute

public void setMinute(int minute)

Gets the number of minutes after the hour at which the time change takes place.
Allowed values: 0 to 59

Parameters:

minute - minute