Back to index

lightning-sunbird  0.9+nobinonly
calIRecurrenceRule.idl
Go to the documentation of this file.
00001 /* -*- Mode: idl; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Oracle Corporation code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  *  Oracle Corporation
00019  * Portions created by the Initial Developer are Copyright (C) 2004
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
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 #include "calIRecurrenceItem.idl"
00042 
00043 interface calIItemBase;
00044 interface calIDateTime;
00045 
00046 // an interface implementing a RRULE
00047 
00048 [scriptable, uuid(c8a953ac-0864-4128-ab3f-b5ba8473fa53)]
00049 interface calIRecurrenceRule : calIRecurrenceItem
00050 {
00051   //
00052   // rule-based recurrence
00053   //
00054 
00055   // null/"", "SECONDLY", "MINUTELY", "HOURLY", "DAILY", "WEEKLY",
00056   // "MONTHLY", "YEARLY"
00057   attribute AUTF8String type;
00058 
00059   // repeat every N of type
00060   // XXX Please mind an implementation detail:
00061   // the underlying libical currently only supports C short values for interval,
00062   // i.e. commonly 16 bits on most platforms, thus please use only 0 <= interval <= 0x7fff.
00063   // It is open whether we go with IDL short here or tweak libical to support at least 32 bits.
00064   attribute long interval;
00065 
00066   // These two are mutually exclusive; whichever is set
00067   // invalidates the other.  It's only valid to read the one
00068   // that was set; the other will throw NS_ERROR_FAILURE.  Use
00069   // isByCount to figure out whether count or endDate is valid.
00070   // Setting count to -1 or endDate to null indicates infinite
00071   // recurrence.
00072   attribute long count;
00073   attribute calIDateTime endDate;
00074 
00075   // if this isn't infinite recurrence, this flag indicates whether
00076   // it was set by count or not
00077   readonly attribute boolean isByCount;
00078 
00079   // the components defining the recurrence
00080   // "BYSECOND", "BYMINUTE", "BYHOUR", "BYDAY",
00081   // "BYMONTHDAY", "BYYEARDAY", "BYWEEKNO", "BYMONTH",
00082   // "BYSETPOS"
00083   void getComponent (in AUTF8String aComponentType,
00084                      out unsigned long aCount, [array,size_is(aCount),retval] out short aValues);
00085   void setComponent (in AUTF8String aComponentType,
00086                      in unsigned long aCount, [array,size_is(aCount)] in short aValues);
00087 
00088 };