err.no Git - scalable-opengroupware.org/blob - SoObjects/Appointments/SOGoAppointmentFolder.h

   1 /*
   2   Copyright (C) 2004-2005 SKYRIX Software AG
   3
   4   This file is part of OpenGroupware.org.
   5
   6   OGo is free software; you can redistribute it and/or modify it under
   7   the terms of the GNU Lesser General Public License as published by the
   8   Free Software Foundation; either version 2, or (at your option) any
   9   later version.
  10
  11   OGo is distributed in the hope that it will be useful, but WITHOUT ANY
  12   WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
  14   License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public
  17   License along with OGo; see the file COPYING.  If not, write to the
  18   Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19   02111-1307, USA.
  20 */
  21
  22 #ifndef __Appointments_SOGoAppointmentFolder_H__
  23 #define __Appointments_SOGoAppointmentFolder_H__
  24
  25 /*
  26   SOGoAppointmentFolder
  27     Parent object: the SOGoUserFolder
  28     Child objects: SOGoAppointmentObject
  29
  30   The SOGoAppointmentFolder maps to an GCS folder of type 'appointment', that
  31   is, a content folder containing iCalendar files (and a proper quicktable).
  32
  33   Important:
  34   The folder assumes a 1:1 mapping between the vevent UID field and the
  35   resource name in the content store. In other words, you are not allowed to
  36   create two different vevent-files with the same uid in the store.
  37 */
  38
  39 #import "SOGo/SOGoFolder.h"
  40
  41 @class NSArray;
  42 @class NSCalendarDate;
  43 @class NSException;
  44 @class NSMutableDictionary;
  45 @class NSString;
  46 @class NSTimeZone;
  47 @class GCSFolder;
  48
  49 @interface SOGoAppointmentFolder : SOGoFolder
  50 {
  51   NSTimeZone *timeZone;
  52   NSMutableDictionary *uidToFilename;
  53 }
  54
  55 /* selection */
  56
  57 - (NSArray *) calendarUIDs;
  58
  59 /* vevent UID handling */
  60
  61 - (NSString *) resourceNameForEventUID: (NSString *) _uid;
  62 - (Class) objectClassForResourceNamed: (NSString *) c_name;
  63
  64 /* fetching */
  65
  66 - (NSArray *) fetchFields: (NSArray *) _fields
  67                fromFolder: (GCSFolder *) _folder
  68                      from: (NSCalendarDate *) _startDate
  69                        to: (NSCalendarDate *) _endDate
  70                 component: (id) _component;
  71
  72 - (NSArray * ) fetchFields: (NSArray *) _fields
  73                       from: (NSCalendarDate *) _startDate
  74                         to: (NSCalendarDate *) _endDate
  75                  component: (id) _component;
  76
  77 - (NSArray *) fetchCoreInfosFrom: (NSCalendarDate *) _startDate
  78                               to: (NSCalendarDate *) _endDate
  79                        component: (id) _component;
  80
  81 - (NSArray *) fetchFreeBusyInfosFrom: (NSCalendarDate *) _startDate
  82                                   to: (NSCalendarDate *) _endDate;
  83
  84 - (void) deleteEntriesWithIds: (NSArray *) ids;
  85
  86 /* URL generation */
  87
  88 - (NSString *) baseURLForAptWithUID: (NSString *) _uid
  89                           inContext: (id) _ctx;
  90
  91 /* folder management */
  92
  93 - (id) lookupHomeFolderForUID: (NSString *) _uid
  94                     inContext: (id) _ctx;
  95
  96 - (SOGoAppointmentFolder *) lookupCalendarFolderForUID: (NSString *) uid;
  97 - (NSArray *) lookupCalendarFoldersForUIDs: (NSArray *) _uids
  98                                  inContext: (id) _ctx;
  99 - (NSArray *) lookupFreeBusyObjectsForUIDs: (NSArray *) _uids
 100                                  inContext: (id) _ctx;
 101
 102 - (NSArray *) uidsFromICalPersons: (NSArray *) _persons;
 103 - (NSArray *) lookupCalendarFoldersForICalPerson: (NSArray *) _persons
 104                                        inContext: (id) _ctx;
 105
 106 - (id) lookupGroupFolderForUIDs: (NSArray *) _uids
 107                       inContext: (id) _ctx;
 108 - (id) lookupGroupCalendarFolderForUIDs: (NSArray *) _uids
 109                               inContext: (id) _ctx;
 110
 111 /* bulk fetches */
 112
 113 - (NSArray *) fetchAllSOGoAppointments;
 114
 115 - (NSArray *) calendarFolders;
 116
 117 @end
 118
 119 #endif /* __Appointments_SOGoAppointmentFolder_H__ */