Package org.opencms.acacia.shared

Interface I_CmsSerialDateValue

All Known Implementing Classes:

A_CmsSerialDateValue, CmsSerialDateValue

public interface I_CmsSerialDateValue

Interface to access serial date values easily. Used on client and server.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	I_CmsSerialDateValue.DateType	Different types of serial dates.
static class	I_CmsSerialDateValue.EndType	Different types of conditions how serial dates can end.
static class	I_CmsSerialDateValue.JsonKey	The JSON keys used in the JSON representation of serial date specifications.
static class	I_CmsSerialDateValue.Month	Months as enumeration.
static class	I_CmsSerialDateValue.PatternType	Type of the series.
static class	I_CmsSerialDateValue.WeekDay	Enumeration representing the week days.
static class	I_CmsSerialDateValue.WeekOfMonth	Possible weeks of a month.

Field Summary

Fields

Modifier and Type	Field	Description
static long	DAY_IN_MILLIS	Constant for the milliseconds of a day.
static int	NUM_OF_WEEKDAYS	The number of weekdays (seven).

Method Summary

Modifier and Type	Method	Description
boolean	endsAtMidNight()	Returns a flag, indicating if the event ends at midnight.
I_CmsSerialDateValue.DateType	getDateType()	Returns the type of the specified date.
int	getDayOfMonth()	Returns the day of the month, the events should take place.
java.util.Date	getEnd()	Returns the end time of the events.
I_CmsSerialDateValue.EndType	getEndType()	Returns the end type of the event series.
java.util.SortedSet<java.util.Date>	getExceptions()	Returns the dates, where the event should not take place.
java.util.SortedSet<java.util.Date>	getIndividualDates()	Returns the dates of an individual date series.
int	getInterval()	Returns the pattern type specific interval of the event.
I_CmsSerialDateValue.Month	getMonth()	Returns the month in which the events take place.
int	getOccurrences()	Returns the number of occurrences of the event.
CmsUUID	getParentSeriesId()	Returns the uuid of the content that holds the series, the current event was extracted from.
I_CmsSerialDateValue.PatternType	getPatternType()	Returns the pattern type of the event series.
java.util.Date	getSeriesEndDate()	Returns the date of the last day, events of the series should take place.
java.util.Date	getStart()	Returns the start time of the events.
I_CmsSerialDateValue.WeekDay	getWeekDay()	Returns the week day where the event should take place.
java.util.SortedSet<I_CmsSerialDateValue.WeekDay>	getWeekDays()	Returns the week days where the event should take place.
I_CmsSerialDateValue.WeekOfMonth	getWeekOfMonth()	Returns the week of the month, the event should take place.
java.util.SortedSet<I_CmsSerialDateValue.WeekOfMonth>	getWeeksOfMonth()	Returns the weeks of the month, the event should take place.
boolean	isCurrentTillEnd()	Returns a flag, indicating if the events should be treated as "current" till they end (or only till they start).
boolean	isEveryWorkingDay()	Returns a flag, indicating if the event should take place every working day.
boolean	isFromOtherSeries()	Returns a flag, indicating if the event is extracted from another series.
boolean	isValid()	Returns a flag, indicating if the value specifies a valid date (series).
boolean	isWholeDay()	Returns a flag, indicating if the event last the whole day/whole days.

Field Detail

DAY_IN_MILLIS

static final long DAY_IN_MILLIS

Constant for the milliseconds of a day.

See Also:

Constant Field Values

NUM_OF_WEEKDAYS

static final int NUM_OF_WEEKDAYS

The number of weekdays (seven).

See Also:

Constant Field Values

Method Detail

endsAtMidNight

boolean endsAtMidNight()

Returns a flag, indicating if the event ends at midnight.

Returns:

a flag, indicating if the event ends at midnight.

getDateType

I_CmsSerialDateValue.DateType getDateType()

Returns the type of the specified date.

Returns:

the type of the specified date.

getDayOfMonth

int getDayOfMonth()

Returns the day of the month, the events should take place.

Returns:

the day of the month, the events should take place.

getEnd

java.util.Date getEnd()

Returns the end time of the events.

Returns:

the end time of the events.

getEndType

I_CmsSerialDateValue.EndType getEndType()

Returns the end type of the event series.

Returns:

the end type of the event series.

getExceptions

java.util.SortedSet<java.util.Date> getExceptions()

Returns the dates, where the event should not take place.

Returns:

the dates, where the event should not take place.

getIndividualDates

java.util.SortedSet<java.util.Date> getIndividualDates()

Returns the dates of an individual date series.

Returns:

the dates of an individual date series.

getInterval

int getInterval()

Returns the pattern type specific interval of the event.

Returns:

the pattern type specific interval of the event.

getMonth

I_CmsSerialDateValue.Month getMonth()

Returns the month in which the events take place.

Returns:

the month in which the events take place.

getOccurrences

int getOccurrences()

Returns the number of occurrences of the event.

Returns:

the number of occurrences of the event.

getParentSeriesId

CmsUUID getParentSeriesId()

Returns the uuid of the content that holds the series, the current event was extracted from. Or null if the current event series was not extracted from another one.

Returns:

the uuid of the original series' content, or null, if the event is not extracted from another event series.

getPatternType

I_CmsSerialDateValue.PatternType getPatternType()

Returns the pattern type of the event series.

Returns:

the pattern type of the event series.

getSeriesEndDate

java.util.Date getSeriesEndDate()

Returns the date of the last day, events of the series should take place.

Returns:

the date of the last day, events of the series should take place.

getStart

java.util.Date getStart()

Returns the start time of the events.

Returns:

the start time of the events.

getWeekDay

I_CmsSerialDateValue.WeekDay getWeekDay()

Returns the week day where the event should take place.

Returns:

the week day where the event should take place.

getWeekDays

java.util.SortedSet<I_CmsSerialDateValue.WeekDay> getWeekDays()

Returns the week days where the event should take place.

Returns:

the week days where the event should take place.

getWeekOfMonth

I_CmsSerialDateValue.WeekOfMonth getWeekOfMonth()

Returns the week of the month, the event should take place.

Returns:

the week of the month, the event should take place.

getWeeksOfMonth

java.util.SortedSet<I_CmsSerialDateValue.WeekOfMonth> getWeeksOfMonth()

Returns the weeks of the month, the event should take place.

Returns:

the weeks of the month, the event should take place.

isCurrentTillEnd

boolean isCurrentTillEnd()

Returns a flag, indicating if the events should be treated as "current" till they end (or only till they start).

Returns:

true if the event is "current" till it ends, false if it is current till it starts.

isEveryWorkingDay

boolean isEveryWorkingDay()

Returns a flag, indicating if the event should take place every working day.

Returns:

a flag, indicating if the event should take place every working day.

isFromOtherSeries

boolean isFromOtherSeries()

Returns a flag, indicating if the event is extracted from another series.

Returns:

a flag, indicating if the event is extracted from another series.

isValid

boolean isValid()

Returns a flag, indicating if the value specifies a valid date (series).

Returns:

a flag, indicating if the value specifies a valid date (series).

isWholeDay

boolean isWholeDay()

Returns a flag, indicating if the event last the whole day/whole days.

Returns:

a flag, indicating if the event last the whole day/whole days.