Back to index

lightning-sunbird  0.9+nobinonly
calIRecurrenceItem.idl
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is Oracle Corporation code.
00015  *
00016  * The Initial Developer of the Original Code is
00017  *  Oracle Corporation
00018  * Portions created by the Initial Developer are Copyright (C) 2004
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
00023  *   Philipp Kewisch <mozilla@kewis.ch>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 
00041 interface calIItemBase;
00042 interface calIDateTime;
00043 
00044 interface calIIcalProperty;
00045 
00046 [scriptable, uuid(943be334-4995-477e-b325-f0c2319183e8)]
00047 interface calIRecurrenceItem : nsISupports
00048 {
00049   // returns true if this thing is able to be modified;
00050   // if the item is not mutable, attempts to modify
00051   // any data will throw CAL_ERROR_ITEM_IS_IMMUTABLE
00052   readonly attribute boolean isMutable;
00053 
00054   // makes this item immutable
00055   void makeImmutable();
00056 
00057   // clone always returns a mutable event
00058   calIRecurrenceItem clone();
00059 
00060   // defaults to false; if true, this item is to be interpreted
00061   // as a negative rule (e.g. exceptions instead of rdates)
00062   attribute boolean isNegative;
00063 
00064   // returns whether this item has a finite number of dates
00065   // or not (e.g. a rule with no end date)
00066   readonly attribute boolean isFinite;
00067 
00076   calIDateTime getNextOccurrence(in calIDateTime aRecurrenceId,
00077                                  in calIDateTime aTime);
00078 
00079   // return array of calIDateTime of the start of all occurrences of
00080   // this event starting at aStartTime, between rangeStart and an
00081   // optional rangeEnd
00082   void getOccurrences (in calIDateTime aStartTime,
00083                        in calIDateTime aRangeStart,
00084                        in calIDateTime aRangeEnd,
00085                        in unsigned long aMaxCount,
00086                        out unsigned long aCount, [array,size_is(aCount),retval] out calIDateTime aDates);
00087 
00088   attribute calIIcalProperty icalProperty;
00089 };