/**
 * Copyright (C) 2003-2007 eXo Platform SAS.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see<http://www.gnu.org/licenses/>.
 **/
package org.exoplatform.calendar.service;

import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;

/**
 * Created by The eXo Platform SARL
 * Author : Hung Nguyen
 *          hung.nguyen@exoplatform.com
 * Jul 2, 2007  
 */
public interface CalendarImportExport {
  public static final String PRIVATE_TYPE = String.valueOf(Calendar.TYPE_PRIVATE);
  public static final String SHARED_TYPE  = String.valueOf(Calendar.TYPE_SHARED);
  public static final String PUBLIC_TYPE  = String.valueOf(Calendar.TYPE_PUBLIC);


  /**
   * The method imports events form icalendar(.ics) or outlook calendar exported .csv file to the system
   * @param username current user name or id
   * @param inputStream data input stream
   * @param calendarId given existed calendar id  
   * @param calendarName name of the new calendar, if create new
   * @param from the first date of current time-range to import event
   * @param to to the last date of current time-range to import event
   * @param isNew import to new calendar or existed calendar
   * @throws Exception
   */
  public void importCalendar(String username, InputStream inputStream, String calendarId, String calendarName, java.util.Calendar from, java.util.Calendar to, boolean isNew) throws Exception;

  /**
   * The method exports events from eXo Calendar to icalendar file (.ics) or .csv file
   * @param username current user name or id
   * @param calendarIds the group calendar ids, if you want to export events from public calendars
   * @param type The type of calendar will be exported
   * @param number the limitation number of event
   * @return data output stream
   * @throws Exception
   */
  public OutputStream exportCalendar(String username, List<String> calendarIds, String type, int number) throws Exception;

  /**
   * The method export calendar event to output stream by given event id
   * @param username current user name or id
   * @param calendarId given calendar id, the calendar event belong to
   * @param type The type of calendar will be exported
   * @param eventId given event id
   * @return data output stream
   * @throws Exception
   */
  public OutputStream exportEventCalendar(String username, String calendarId, String type, String eventId) throws Exception;

  /**
   * The method maps the input stream to event object
   * @param icalInputStream the input stream
   * @return List of calendar event objects contant infomations
   * @throws Exception
   */
  public List<CalendarEvent> getEventObjects(InputStream icalInputStream) throws Exception;

  /**
   * The method return true if the input stream is correct format 
   * @param icalInputStream the input stream
   * @throws Exception
   */
  public boolean isValidate(InputStream icalInputStream) throws Exception;

  /**
   * The method export binary from event object
   * @param event : event object
   * @return binary ics file
   * @throws Exception
   */
  public ByteArrayOutputStream exportEventCalendar(CalendarEvent event) throws Exception;
}
