public abstract class CalendarKeyword
extends java.lang.Object
Constructor and Description |
---|
CalendarKeyword() |
Modifier and Type | Method and Description |
---|---|
boolean |
containsDate(DateTime date)
Checks if a date matches this keyword.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getCalendarName()
Returns the parent calendar object name, this is necessary to identify a calendar keyword
|
java.lang.String |
getErrorMessageInsert()
Returns the insert string in case errorMessageNumber is not 0.
|
int |
getErrorMessageNumber()
Returns the number of the error message or
0 if there is no error in this calendar keyword. |
java.lang.String |
getErrorText()
Returns the text of the error message or
null if there is no error in this calendar keyword. |
UC4ObjectName |
getName()
Returns the name of the Calendar Keyword.
|
java.util.SortedSet<DateTime> |
getPreCalculatedDates() |
int |
hashCode() |
protected void |
invalidateCalculatedDates() |
abstract boolean |
isGroup()
Returns
true if this is a group keyword. |
abstract boolean |
isMonthly()
Returns
true if this is a monthly keyword. |
abstract boolean |
isRoll()
Returns
true if this is a roll keyword. |
abstract boolean |
isStatic()
Returns
true if this is a static keyword. |
abstract boolean |
isWeekly()
Returns
true if this is a weekly keyword. |
abstract boolean |
isYearly()
Returns
true if this is a yearly keyword. |
protected void |
loadCalculatedDays(org.w3c.dom.Element keyword) |
protected abstract void |
save(com.uc4.util.XMLDocument doc,
org.w3c.dom.Element parent)
Saves the keyword under the specified parent element
|
protected void |
setCalendarName(java.lang.String name) |
void |
setErrorMessageInsert(java.lang.String errorMessageInsert)
Sets the error message insert.
|
protected void |
setErrorMessageNumber(int errorMessageNumber) |
protected void |
setErrorText(java.lang.String errorText) |
void |
setName(UC4ObjectName name)
Sets the name of the Calendar Keyword.
|
java.lang.String |
toString() |
public int getErrorMessageNumber()
0
if there is no error in this calendar keyword.public java.lang.String getErrorMessageInsert()
public java.lang.String getErrorText()
null
if there is no error in this calendar keyword.protected void setErrorMessageNumber(int errorMessageNumber)
protected void setErrorText(java.lang.String errorText)
public void setErrorMessageInsert(java.lang.String errorMessageInsert)
errorMessageInsert
- Insertpublic UC4ObjectName getName()
public void setName(UC4ObjectName name)
name
- UC4ObjectName containing the calendar keywordpublic abstract boolean isStatic()
true
if this is a static keyword.public abstract boolean isWeekly()
true
if this is a weekly keyword.public abstract boolean isMonthly()
true
if this is a monthly keyword.public abstract boolean isYearly()
true
if this is a yearly keyword.public abstract boolean isGroup()
true
if this is a group keyword.public abstract boolean isRoll()
true
if this is a roll keyword.protected abstract void save(com.uc4.util.XMLDocument doc, org.w3c.dom.Element parent)
doc
- XML Documentparent
- Parent elementprotected void setCalendarName(java.lang.String name)
public java.lang.String getCalendarName()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
protected void invalidateCalculatedDates()
public boolean containsDate(DateTime date)
date
- Date to checkprotected void loadCalculatedDays(org.w3c.dom.Element keyword)
public java.util.SortedSet<DateTime> getPreCalculatedDates()