/**
 * Copyright (C) 2011 Hippo B.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onehippo.forge.socialsharing.beans;

import java.util.Calendar;

/**
 * Interface for iCalendar file generation
 */
public interface IEventDocument {

    /**
     * Defines the title of the event (iCalendar vEvent SUMMARY)
     *
     * @return title
     */
    String getTitle();


    /**
     * Start date of the event (iCalendar vEvent DTSTART)
     *
     * @return {@link Calendar} that is the start of the event
     */
    Calendar getDate();

    /**
     * End date of the event (iCalendar vEvent DTEND)
     *
     * @return {@link Calendar} that is the end of the event
     */
    Calendar getEndDate();

    /**
     * Event summary  (iCalendar vEvent DESCRIPTION)
     *
     * @return summary
     */
    String getSummary();

    /**
     * Is used for the iCalendar vEvent name
     *
     * @return name
     */
    String getName();

    /**
     * Copied from {@link org.hippoecm.hst.content.beans.standard.HippoDocumentBean}
     *
     * @return the uuid of the canonical handle (the physical node) and <code>null</code> if some exception happened
     */
    String getCanonicalHandleUUID();
}