com.uc4.api.objects

Class WeeklyCalendarKeyword

java.lang.Object

com.uc4.api.objects.CalendarKeyword

com.uc4.api.objects.WeeklyCalendarKeyword

public class WeeklyCalendarKeyword
extends CalendarKeyword

This class represents a weekly calendar keyword.

Constructor Summary

Constructors

Modifier	Constructor and Description
	WeeklyCalendarKeyword(UC4ObjectName name) Constructs a new WeeklyCalendarKeyword.
	WeeklyCalendarKeyword(UC4ObjectName name, int nWeek, int startWeek, int endWeek) Constructs a new WeeklyCalendarKeyword.
protected	WeeklyCalendarKeyword(com.uc4.util.XMLDocument doc, org.w3c.dom.Element keyword, java.lang.String string)

Method Summary

Modifier and Type	Method and Description
int	getEndWeek() Returns the end week for the interval.
int	getNWeek() Returns the interval in weeks.
int	getStartWeek() Returns the start week for the interval.
boolean	isFriday() Returns true if friday is selected.
boolean	isGroup() Returns true if this is a group keyword.
boolean	isMonday() Returns true if monday is selected.
boolean	isMonthly() Returns true if this is a monthly keyword.
boolean	isRoll() Returns true if this is a roll keyword.
boolean	isSaturday() Returns true if saturday is selected.
boolean	isStatic() Returns true if this is a static keyword.
boolean	isSunday() Returns true if sunday is selected.
boolean	isThursday() Returns true if thursday is selected.
boolean	isTuesday() Returns true if tuesday is selected.
boolean	isWednesday() Returns true if wednesday is selected.
boolean	isWeekly() Returns true if this is a weekly keyword.
boolean	isYearly() Returns true if this is a yearly keyword.
protected void	save(com.uc4.util.XMLDocument doc, org.w3c.dom.Element parent) Saves the keyword under the specified parent element
void	setEndWeek(int endWeek) Sets the end week for the interval.
void	setFriday(boolean friday) Selects or deselects friday.
void	setMonday(boolean monday) Selects or deselects monday.
void	setNWeek(int week) Sets the interval in weeks.
void	setSaturday(boolean saturday) Selects or deselects saturday.
void	setStartWeek(int startWeek) Sets the start week for the interval.
void	setSunday(boolean sunday) Selects or deselects sunday.
void	setThursday(boolean thursday) Selects or deselects thursday.
void	setTuesday(boolean tuesday) Selects or deselects tuesday.
void	setWednesday(boolean wednesday) Selects or deselects wednesday.

Methods inherited from class com.uc4.api.objects.CalendarKeyword

containsDate, equals, getCalendarName, getErrorMessageInsert, getErrorMessageNumber, getErrorText, getName, getPreCalculatedDates, hashCode, invalidateCalculatedDates, loadCalculatedDays, setCalendarName, setErrorMessageInsert, setErrorMessageNumber, setErrorText, setName, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WeeklyCalendarKeyword

protected WeeklyCalendarKeyword(com.uc4.util.XMLDocument doc,
                                org.w3c.dom.Element keyword,
                                java.lang.String string)

WeeklyCalendarKeyword

public WeeklyCalendarKeyword(UC4ObjectName name,
                             int nWeek,
                             int startWeek,
                             int endWeek)

Constructs a new WeeklyCalendarKeyword.

Parameters:

name - Name of the calendar keyword

nWeek - Every n week, integer between 1 and 54

startWeek - First week, integer between 0 and 54

endWeek - Last week, integer between 0 and 54

WeeklyCalendarKeyword

public WeeklyCalendarKeyword(UC4ObjectName name)

Constructs a new WeeklyCalendarKeyword. Every week starting with week 0 and ending with 54 is selected.

Parameters:

name - Name of the calendar keyword

Method Detail

getEndWeek

public int getEndWeek()

Returns the end week for the interval.

Returns:

Integer containg the end week

setEndWeek

public void setEndWeek(int endWeek)

Sets the end week for the interval.

Parameters:

endWeek - Integer containing the end week, between 0 and 54

getNWeek

public int getNWeek()

Returns the interval in weeks.

Returns:

Interval in weeks

setNWeek

public void setNWeek(int week)

Sets the interval in weeks.

Parameters:

week - Interval in weeks, integer between 1 and 54

getStartWeek

public int getStartWeek()

Returns the start week for the interval.

Returns:

Integer containg the start week

setStartWeek

public void setStartWeek(int startWeek)

Sets the start week for the interval.

Parameters:

startWeek - Integer containing the start week, between 0 and 54

isFriday

public boolean isFriday()

Returns true if friday is selected.

Returns:

Boolean containg true if friday is selected

setFriday

public void setFriday(boolean friday)

Selects or deselects friday.

Parameters:

friday - Boolean containg true if friday should be selected

isMonday

public boolean isMonday()

Returns true if monday is selected.

Returns:

Boolean containg true if monday is selected

setMonday

public void setMonday(boolean monday)

Selects or deselects monday.

Parameters:

monday - Boolean containg true if monday should be selected

isSaturday

public boolean isSaturday()

Returns true if saturday is selected.

Returns:

Boolean containg true if saturday is selected

setSaturday

public void setSaturday(boolean saturday)

Selects or deselects saturday.

Parameters:

saturday - Boolean containg true if saturday should be selected

isSunday

public boolean isSunday()

Returns true if sunday is selected.

Returns:

Boolean containg true if sunday is selected

setSunday

public void setSunday(boolean sunday)

Selects or deselects sunday.

Parameters:

sunday - Boolean containg true if sunday should be selected

isThursday

public boolean isThursday()

Returns true if thursday is selected.

Returns:

Boolean containg true if thursday is selected

setThursday

public void setThursday(boolean thursday)

Selects or deselects thursday.

Parameters:

thursday - Boolean containg true if thursday should be selected

isTuesday

public boolean isTuesday()

Returns true if tuesday is selected.

Returns:

Boolean containg true if tuesday is selected

setTuesday

public void setTuesday(boolean tuesday)

Selects or deselects tuesday.

Parameters:

tuesday - Boolean containg true if tuesday should be selected

isWednesday

public boolean isWednesday()

Returns true if wednesday is selected.

Returns:

Boolean containg true if wednesday is selected

setWednesday

public void setWednesday(boolean wednesday)

Selects or deselects wednesday.

Parameters:

wednesday - Boolean containg true if wednesday should be selected

isStatic

public boolean isStatic()

Description copied from class: CalendarKeyword

Returns true if this is a static keyword.

Specified by:

isStatic in class CalendarKeyword

Returns:

Boolean containing true in case of a static keyword

isWeekly

public boolean isWeekly()

Description copied from class: CalendarKeyword

Returns true if this is a weekly keyword.

Specified by:

isWeekly in class CalendarKeyword

Returns:

Boolean containing true in case of a weekly keyword

isMonthly

public boolean isMonthly()

Description copied from class: CalendarKeyword

Returns true if this is a monthly keyword.

Specified by:

isMonthly in class CalendarKeyword

Returns:

Boolean containing true in case of a monthly keyword

isYearly

public boolean isYearly()

Description copied from class: CalendarKeyword

Returns true if this is a yearly keyword.

Specified by:

isYearly in class CalendarKeyword

Returns:

Boolean containing true in case of a yearly keyword

isGroup

public boolean isGroup()

Description copied from class: CalendarKeyword

Returns true if this is a group keyword.

Specified by:

isGroup in class CalendarKeyword

Returns:

Boolean containing true in case of a group keyword

isRoll

public boolean isRoll()

Description copied from class: CalendarKeyword

Returns true if this is a roll keyword.

Specified by:

isRoll in class CalendarKeyword

Returns:

Boolean containing true in case of a roll keyword

save

protected void save(com.uc4.util.XMLDocument doc,
                    org.w3c.dom.Element parent)

Description copied from class: CalendarKeyword

Saves the keyword under the specified parent element

Specified by:

save in class CalendarKeyword

Parameters:

doc - XML Document

parent - Parent element