/*
 *  Copyright 2014 Anyware Services
 *
 *  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.ametys.plugins.explorer.calendars;

import java.util.Date;
import java.util.List;

import org.ametys.core.user.UserIdentity;
import org.ametys.plugins.repository.AmetysRepositoryException;
import org.ametys.plugins.repository.metadata.UnknownMetadataException;
import org.ametys.plugins.workflow.repository.WorkflowAwareAmetysObject;

/**
 * Calendar event interface
 */
public interface CalendarEvent extends WorkflowAwareAmetysObject
{
    /**
     * Get the title of the event
     * @return the title of the event
     */
    public String getTitle();
    
    /**
     * Get the description of the event
     * @return the description of the event
     */
    public String getDescription();
    
    /**
     * Get the location of the event
     * @return the location of the event
     */
    public String getLocation();
    
    /**
     * Get the date of the begin of the event
     * @return the date of the event
     */
    public Date getStartDate();
    
    /**
     * Get the date of the end of the event
     * @return the date of the event
     */
    public Date getEndDate();
    
    /**
     * Get if the event last all the day
     * @return true if the event last all the day
     */
    public Boolean getFullDay();
    
    /**
     * Retrieves the the creator.
     * @return the creator.
     * @throws UnknownMetadataException if this property does not exists.
     * @throws AmetysRepositoryException if an error occurs.
     */
    public UserIdentity getCreator() throws UnknownMetadataException, AmetysRepositoryException;
    
    /**
     * Retrieves the creation date.
     * @return the creation date.
     * @throws UnknownMetadataException if this property does not exists.
     * @throws AmetysRepositoryException if an error occurs.
     */
    public Date getCreationDate() throws UnknownMetadataException, AmetysRepositoryException;
    
    /**
     * Retrieves the last contributor.
     * @return the last contributor.
     * @throws UnknownMetadataException if this property does not exists.
     * @throws AmetysRepositoryException if an error occurs.
     */
    public UserIdentity getLastContributor() throws UnknownMetadataException, AmetysRepositoryException;
    
    /**
     * Retrieves the last modification date.
     * @return the last modification date.
     * @throws UnknownMetadataException if this property does not exists.
     * @throws AmetysRepositoryException if an error occurs.
     */
    public Date getLastModified() throws UnknownMetadataException, AmetysRepositoryException;
    
    /**
     * Retrieves the last validator.
     * @return the last validator.
     * @throws UnknownMetadataException if this property does not exists.
     * @throws AmetysRepositoryException if an error occurs.
     */
    public UserIdentity getLastValidator() throws UnknownMetadataException, AmetysRepositoryException;
   
   /**
     * Retrieves the last validation date.
     * @return the last validation date.
     * @throws UnknownMetadataException if this property does not exists.
     * @throws AmetysRepositoryException if an error occurs.
     */
    public Date getLastValidated() throws UnknownMetadataException, AmetysRepositoryException;
   
    /**
     * Returns the keywords of this event, as a String array.
     * @return the keywords of this event.
     * @throws AmetysRepositoryException if an error occurs.
     */
    public String[] getKeywords() throws AmetysRepositoryException;
    
    /**
     * Retrieves the recurrence type.
     * @return the recurrence type.
     */
    public EventRecurrenceTypeEnum getRecurrenceType();
    
    /**
     * Retrieves if the event is recurrent.
     * @return true if the event is recurrent.
     */
    public Boolean isRecurrent();
    
    /**
     * Retrieves the end date of the frequency.
     * @return the end date of the frequency.
     */
    public Date getRepeatUntil();
    
    /**
     * Retrieves the list of excluded event date.
     * @return the list of excluded event date.
     */
    public List<Date> getExcludedOccurences();
    
    /**
     * Retrieves the list of all event date between startDate and endDate.
     * @param startDate the start date
     * @param endDate the end date
     * @return the list of all event date between startDate and endDate.
     */
    public List<Date> getOccurrences(Date startDate, Date endDate);
    
    /**
     * Retrieves the start date of the first Event which end after the date
     * @param date the date
     * @return the start date of the first Event which end after the date
     */
    public Date getFirstOccurrence(Date date);
    
    /**
     * Retrieves the date of the next event after the date
     * @param date the date
     * @return the date of the next event after the date
     */
    public Date getNextOccurrence(Date date);
    
    /**
     * Retrieves the organiser.
     * @return the organiser.
     * @throws UnknownMetadataException if this property does not exists.
     * @throws AmetysRepositoryException if an error occurs.
     */
    public UserIdentity getOrganiser() throws UnknownMetadataException, AmetysRepositoryException;
    
}