err.no Git - scalable-opengroupware.org/blob - SoObjects/SOGo/SOGoFolder.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 __SOGo_SOGoFolder_H__
  23 #define __SOGo_SOGoFolder_H__
  24
  25 #import "SOGoObject.h"
  26
  27 @class NSArray;
  28 @class NSDictionary;
  29 @class NSMutableDictionary;
  30 @class NSString;
  31
  32 @class GCSFolder;
  33
  34 /*
  35   SOGoFolder
  36
  37   A common superclass for folders stored in GCS. Already deals with all GCS
  38   folder specific things.
  39
  40   Important: folders should NOT retain the context! Otherwise you might get
  41              cyclic references.
  42 */
  43
  44 @interface SOGoFolder : SOGoObject
  45 {
  46   NSMutableString *displayName;
  47   NSString *ocsPath;
  48   GCSFolder *ocsFolder;
  49   NSMutableDictionary *aclCache;
  50 }
  51
  52 + (id) folderWithSubscriptionReference: (NSString *) reference
  53                            inContainer: (id) aContainer;
  54
  55 /* accessors */
  56
  57 - (void) setDisplayName: (NSString *) newDisplayName;
  58 - (NSString *) displayName;
  59
  60 - (void) setOCSPath: (NSString *)_Path;
  61 - (NSString *) ocsPath;
  62
  63 - (GCSFolder *) ocsFolderForPath: (NSString *)_path;
  64 - (GCSFolder *) ocsFolder;
  65
  66 /* lower level fetches */
  67 - (BOOL) nameExistsInFolder: (NSString *) objectName;
  68
  69 - (void) deleteEntriesWithIds: (NSArray *) ids;
  70
  71 - (NSArray *) fetchContentObjectNames;
  72 - (NSDictionary *) fetchContentStringsAndNamesOfAllObjects;
  73
  74 /* folder type */
  75
  76 - (NSString *) outlookFolderClass;
  77
  78 - (BOOL) folderIsMandatory;
  79 - (NSString *) folderType;
  80
  81 - (BOOL) create;
  82 - (NSException *) delete;
  83 - (void) renameTo: (NSString *) newName;
  84 /* dav */
  85 - (NSArray *) davNamespaces;
  86
  87 /* acls as a container */
  88 - (NSArray *) aclUsersForObjectAtPath: (NSArray *) objectPathArray;
  89 - (NSArray *) aclsForUser: (NSString *) uid
  90           forObjectAtPath: (NSArray *) objectPathArray;
  91 - (void) setRoles: (NSArray *) roles
  92           forUser: (NSString *) uid
  93   forObjectAtPath: (NSArray *) objectPathArray;
  94 - (void) removeAclsForUsers: (NSArray *) users
  95             forObjectAtPath: (NSArray *) objectPathArray;
  96
  97 @end
  98
  99 @interface SOGoFolder (GroupDAVExtensions)
 100
 101 - (NSString *) groupDavResourceType;
 102
 103 @end
 104
 105 #endif /* __SOGo_SOGoFolder_H__ */