com.uc4.api.objects

Class GroupCalendarKeyword

java.lang.Object

com.uc4.api.objects.CalendarKeyword

com.uc4.api.objects.GroupCalendarKeyword

public class GroupCalendarKeyword
extends CalendarKeyword

This class represents a group calendar keyword.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GroupCalendarKeyword(org.w3c.dom.Element keyword, java.lang.String string)
	GroupCalendarKeyword(UC4ObjectName name) Constructs a new GroupCalendarKeyword.

Method Summary

Modifier and Type	Method and Description
void	addCalendarConditionAll(CalendarCondition cond) Adds a calendar condition to the list of conditions where all least one must apply.
void	addCalendarConditionNone(CalendarCondition cond) Adds a calendar condition to the list of conditions where none of the calendar conditions must apply.
void	addCalendarConditionOne(CalendarCondition cond) Adds a calendar condition to the list of conditions where at least one must apply.
java.util.Iterator<CalendarCondition>	allIterator() Returns an iterator over CalendarCondition where all calendar conditions must apply This iterator can be used to read or remove calendar conditions.
boolean	isGroup() Returns true if this is a group keyword.
boolean	isMonthly() Returns true if this is a monthly keyword.
boolean	isRoll() Returns true if this is a roll keyword.
boolean	isStatic() Returns true if this is a static keyword.
boolean	isWeekly() Returns true if this is a weekly keyword.
boolean	isYearly() Returns true if this is a yearly keyword.
java.util.Iterator<CalendarCondition>	noneIterator() Returns an iterator over CalendarCondition where none of the calendar conditions apply This iterator can be used to read or remove calendar conditions.
java.util.Iterator<CalendarCondition>	oneIterator() Returns an iterator over CalendarCondition where at least one calendar condition must apply This iterator can be used to read or remove calendar conditions.
protected void	save(com.uc4.util.XMLDocument doc, org.w3c.dom.Element parent) Saves the keyword under the specified parent element

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

GroupCalendarKeyword

protected GroupCalendarKeyword(org.w3c.dom.Element keyword,
                               java.lang.String string)

GroupCalendarKeyword

public GroupCalendarKeyword(UC4ObjectName name)

Constructs a new GroupCalendarKeyword.

Parameters:

name - Name of the calendar keyword

Method Detail

oneIterator

public java.util.Iterator<CalendarCondition> oneIterator()

Returns an iterator over CalendarCondition where at least one calendar condition must apply This iterator can be used to read or remove calendar conditions.

Returns:

Iterator over calendar conditions

allIterator

public java.util.Iterator<CalendarCondition> allIterator()

Returns an iterator over CalendarCondition where all calendar conditions must apply This iterator can be used to read or remove calendar conditions.

Returns:

Iterator over calendar conditions

noneIterator

public java.util.Iterator<CalendarCondition> noneIterator()

Returns an iterator over CalendarCondition where none of the calendar conditions apply This iterator can be used to read or remove calendar conditions.

Returns:

Iterator over calendar conditions

addCalendarConditionAll

public void addCalendarConditionAll(CalendarCondition cond)

Adds a calendar condition to the list of conditions where all least one must apply.

Parameters:

cond - Calendar Condition

addCalendarConditionOne

public void addCalendarConditionOne(CalendarCondition cond)

Adds a calendar condition to the list of conditions where at least one must apply.

Parameters:

cond - Calendar Condition

addCalendarConditionNone

public void addCalendarConditionNone(CalendarCondition cond)

Adds a calendar condition to the list of conditions where none of the calendar conditions must apply.

Parameters:

cond - Calendar Condition

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