001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.widgets.serialdate;
029
030import java.util.Date;
031import java.util.SortedSet;
032
033/**
034 * Interface for serial date beans.
035 *
036 * Serial date beans allow easy access to values stored by the {@link org.opencms.widgets.CmsSerialDateWidget}.
037 */
038public interface I_CmsSerialDateBean {
039
040    /**
041     * Returns all dates of the whole series as {@link Date} objects, sorted ascendingly.
042     * @return  all dates of the whole series as {@link Date} objects, sorted ascendingly.
043     */
044    public SortedSet<Date> getDates();
045
046    /**
047     * Returns all dates of the whole series in milliseconds, sorted ascendingly.
048     * @return  all dates of the whole series in milliseconds, sorted ascendingly.
049     */
050    public SortedSet<Long> getDatesAsLong();
051
052    /**
053     * Returns the duration of a single event in milliseconds, or <code>null</code> if no end date is specified.
054     * @return the duration of a single event in milliseconds, or <code>null</code> if no end date is specified.
055     */
056    public Long getEventDuration();
057
058    /**
059     * Returns all exceptions from the series, sorted ascendingly.
060     * @return all exceptions from the series, sorted ascendingly.
061     */
062    public SortedSet<Date> getExceptions();
063
064    /**
065     * Returns a flag, indicating if the series has more dates than allowed.
066     * @return a flag, indicating if the series has more dates than allowed.
067     */
068    public boolean hasTooManyDates();
069}