Back to index

lightning-sunbird  0.9+nobinonly
calIFreeBusyProvider.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 Sun Microsystems code.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Sun Microsystems, Inc.
00018  * Portions created by the Initial Developer are Copyright (C) 2007
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Daniel Boelzle <daniel.boelzle@sun.com>
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 
00040 interface calIDateTime;
00041 interface calIPeriod;
00042 interface calIOperation;
00043 interface calIGenericOperationListener;
00044 
00045 [scriptable, uuid(EB24424C-DD22-4306-9379-FA098C61F5AF)]
00046 interface calIFreeBusyProvider : nsISupports
00047 {
00059     calIOperation getFreeBusyIntervals(in AUTF8String aCalId,
00060                                        in calIDateTime aRangeStart,
00061                                        in calIDateTime aRangeEnd,
00062                                        in unsigned long aBusyTypes,
00063                                        in calIGenericOperationListener aListener);
00064 };
00065 
00070 [scriptable, uuid(CCBEAF5E-DB87-4bc9-8BB7-24754B76BCB5)]
00071 interface calIFreeBusyInterval : nsISupports
00072 {
00076     readonly attribute AUTF8String calId;
00077 
00081     readonly attribute calIPeriod interval;
00082 
00087     const unsigned long UNKNOWN = 0;
00088 
00092     const unsigned long FREE = 1;
00093 
00098     const unsigned long BUSY = 1 << 1;
00099 
00104     const unsigned long BUSY_UNAVAILABLE = 1 << 2;
00105 
00110     const unsigned long BUSY_TENTATIVE = 1 << 3;
00111 
00115     const unsigned long BUSY_ALL = (BUSY |
00116                                     BUSY_UNAVAILABLE |
00117                                     BUSY_TENTATIVE);
00118 
00122     readonly attribute unsigned long freeBusyType;
00123 };
00124 
00130 [scriptable, uuid(BE1796CF-CB53-482e-8942-D6CAA0A11BAA)]
00131 interface calIFreeBusyService : calIFreeBusyProvider
00132 {
00136     void addProvider(in calIFreeBusyProvider aProvider);
00137 
00141     void removeProvider(in calIFreeBusyProvider aProvider);
00142 };