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 NSString, NSArray, NSCalendarDate, NSException, NSMutableDictionary;
  42 @class GCSFolder;
  43
  44 @interface SOGoAppointmentFolder : SOGoFolder
  45 {
  46   NSMutableDictionary *uidToFilename;
  47 }
  48
  49 /* selection */
  50
  51 - (NSArray *) calendarUIDs;
  52
  53 /* vevent UID handling */
  54
  55 - (NSString *) resourceNameForEventUID: (NSString *) _uid;
  56 - (Class) objectClassForResourceNamed: (NSString *) c_name;
  57
  58 /* fetching */
  59
  60 - (NSArray *) fetchFields: (NSArray *) _fields
  61                fromFolder: (GCSFolder *) _folder
  62                      from: (NSCalendarDate *) _startDate
  63                        to: (NSCalendarDate *) _endDate
  64                 component: (id) _component;
  65
  66 - (NSArray * ) fetchFields: (NSArray *) _fields
  67                       from: (NSCalendarDate *) _startDate
  68                         to: (NSCalendarDate *) _endDate
  69                  component: (id) _component;
  70
  71 - (NSArray *) fetchCoreInfosFrom: (NSCalendarDate *) _startDate
  72                               to: (NSCalendarDate *) _endDate
  73                        component: (id) _component;
  74
  75 - (NSArray *) fetchFreeBusyInfosFrom: (NSCalendarDate *) _startDate
  76                                   to: (NSCalendarDate *) _endDate;
  77
  78 - (void) deleteEntriesWithIds: (NSArray *) ids;
  79
  80 /* URL generation */
  81
  82 - (NSString *) baseURLForAptWithUID: (NSString *) _uid
  83                           inContext: (id) _ctx;
  84
  85 /* folder management */
  86
  87 - (id) lookupHomeFolderForUID: (NSString *) _uid
  88                     inContext: (id) _ctx;
  89
  90 - (SOGoAppointmentFolder *) lookupCalendarFolderForUID: (NSString *) uid;
  91 - (NSArray *) lookupCalendarFoldersForUIDs: (NSArray *) _uids
  92                                  inContext: (id) _ctx;
  93 - (NSArray *) lookupFreeBusyObjectsForUIDs: (NSArray *) _uids
  94                                  inContext: (id) _ctx;
  95
  96 - (NSArray *) uidsFromICalPersons: (NSArray *) _persons;
  97 - (NSArray *) lookupCalendarFoldersForICalPerson: (NSArray *) _persons
  98                                        inContext: (id) _ctx;
  99
 100 - (id) lookupGroupFolderForUIDs: (NSArray *) _uids
 101                       inContext: (id) _ctx;
 102 - (id) lookupGroupCalendarFolderForUIDs: (NSArray *) _uids
 103                               inContext: (id) _ctx;
 104
 105 /* bulk fetches */
 106
 107 - (NSArray *) fetchAllSOGoAppointments;
 108
 109 @end
 110
 111 #endif /* __Appointments_SOGoAppointmentFolder_H__ */