calendar/base/public/calIRecurrenceItem.idl
author Edmund Wong <ewong@pw-wspx.org>
Mon, 12 Mar 2012 15:27:17 +0800
changeset 11058 2af54b6c02f22005cb8d0a70c2766e32d06cafa9
parent 372 7c0bfdcda6731e77303f3c47b01736aaa93d5534
child 12286 84ac3c71109811da751f0ef2d72108075938f094
permissions -rw-r--r--
Bug 731223 - Update help from changes from bug #694514 and bug #733258. r=InvisibleSmiley

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Oracle Corporation code.
 *
 * The Initial Developer of the Original Code is
 *  Oracle Corporation
 * Portions created by the Initial Developer are Copyright (C) 2004
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
 *   Philipp Kewisch <mozilla@kewis.ch>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

interface calIItemBase;
interface calIDateTime;

interface calIIcalProperty;

[scriptable, uuid(943be334-4995-477e-b325-f0c2319183e8)]
interface calIRecurrenceItem : nsISupports
{
  // returns true if this thing is able to be modified;
  // if the item is not mutable, attempts to modify
  // any data will throw CAL_ERROR_ITEM_IS_IMMUTABLE
  readonly attribute boolean isMutable;

  // makes this item immutable
  void makeImmutable();

  // clone always returns a mutable event
  calIRecurrenceItem clone();

  // defaults to false; if true, this item is to be interpreted
  // as a negative rule (e.g. exceptions instead of rdates)
  attribute boolean isNegative;

  // returns whether this item has a finite number of dates
  // or not (e.g. a rule with no end date)
  readonly attribute boolean isFinite;

  /**
   * Search for the next occurrence after aTime and return its recurrence id.
   * aRecurrenceId must be the recurrence id of an occurrence to search after.
   *
   * @require               (aTime >= aRecurrenceId)
   * @param aRecurrenceId   The recurrence id to start searching at.
   * @param aTime           The earliest time to find the occurrence after.
   */
  calIDateTime getNextOccurrence(in calIDateTime aRecurrenceId,
                                 in calIDateTime aTime);

  // return array of calIDateTime of the start of all occurrences of
  // this event starting at aStartTime, between rangeStart and an
  // optional rangeEnd
  void getOccurrences (in calIDateTime aStartTime,
                       in calIDateTime aRangeStart,
                       in calIDateTime aRangeEnd,
                       in unsigned long aMaxCount,
                       out unsigned long aCount, [array,size_is(aCount),retval] out calIDateTime aDates);

  attribute calIIcalProperty icalProperty;
};