Package org.opencms.widgets.serialdate

Class CmsSerialDateBeanYearly

java.lang.Object

org.opencms.widgets.serialdate.A_CmsSerialDateBean

org.opencms.widgets.serialdate.CmsSerialDateBeanYearly

All Implemented Interfaces:

I_CmsSerialDateBean

public class CmsSerialDateBeanYearly
extends A_CmsSerialDateBean

Implementation of @{link org.opencms.widgets.serialdate.I_CmsSerialDateBean} that handles series' specified on a yearly base.

Field Summary

Fields inherited from class org.opencms.widgets.serialdate.A_CmsSerialDateBean

m_allDates, m_dates, m_datesInMillis, m_endDate, m_endMillis, m_endType, m_exceptions, m_occurrences, m_serialEndDate, m_startDate, MAX_OCCURRENCES

Constructor Summary

Constructors

Constructor	Description
CmsSerialDateBeanYearly(java.util.Date startDate, java.util.Date endDate, boolean isWholeDay, I_CmsSerialDateValue.EndType endType, java.util.Date serialEndDate, int occurrences, java.util.SortedSet<java.util.Date> exceptions, int dayOfMonth, I_CmsSerialDateValue.Month month)	Constructs the bean with all the information provided by the CmsSerialDateWidget.

Method Summary

Modifier and Type	Method	Description
protected java.util.Calendar	getFirstDate()	Generates the first date of the series.
protected boolean	isAnyDatePossible()	Check, if the series can have at least one event/date.
protected void	toNextDate(java.util.Calendar date)	Starting with a date that's in the series, the next date is created.

Methods inherited from class org.opencms.widgets.serialdate.A_CmsSerialDateBean

getDates, getDatesAsLong, getEventDuration, getExceptions, getOccurrences, getSerialEndDate, getSerialEndType, getStartDate, hasTooManyDates, showMoreEntries

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsSerialDateBeanYearly

public CmsSerialDateBeanYearly(java.util.Date startDate,
                               java.util.Date endDate,
                               boolean isWholeDay,
                               I_CmsSerialDateValue.EndType endType,
                               java.util.Date serialEndDate,
                               int occurrences,
                               java.util.SortedSet<java.util.Date> exceptions,
                               int dayOfMonth,
                               I_CmsSerialDateValue.Month month)

Constructs the bean with all the information provided by the CmsSerialDateWidget.

Parameters:

startDate - the start date of the series as provided by the serial date widget.

endDate - the end date of the series as provided by the serial date widget.

isWholeDay - flag, indicating if the event lasts the whole day

endType - the end type of the series as provided by the serial date widget.

serialEndDate - the end date of the series as provided by the serial date widget.

occurrences - the maximal number of occurrences of the event as provided by the serial date widget.

exceptions - dates where the event does not take place, even if it is in the series.

dayOfMonth - if weekDay is null the day of the month the event should occur, otherwise the number of the specific week day in the month where event should occur.

month - the month in which the event should occur

Method Detail

getFirstDate

protected java.util.Calendar getFirstDate()

Description copied from class: A_CmsSerialDateBean

Generates the first date of the series.

Specified by:

getFirstDate in class A_CmsSerialDateBean

Returns:

the first date of the series.

See Also:

A_CmsSerialDateBean.getFirstDate()

isAnyDatePossible

protected boolean isAnyDatePossible()

Description copied from class: A_CmsSerialDateBean

Check, if the series can have at least one event/date.

Specified by:

isAnyDatePossible in class A_CmsSerialDateBean

Returns:

true if the series can be non-empty, false otherwise.

See Also:

A_CmsSerialDateBean.isAnyDatePossible()

toNextDate

protected void toNextDate(java.util.Calendar date)

Description copied from class: A_CmsSerialDateBean

Starting with a date that's in the series, the next date is created.

Specified by:

toNextDate in class A_CmsSerialDateBean

Parameters:

date - the current event date for a event in the series, which is adjusted to the next date potentially in the series.

See Also:

A_CmsSerialDateBean.toNextDate(java.util.Calendar)