err.no Git - scalable-opengroupware.org/blob - SoObjects/SOGo/SOGoObject.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 __SoObjects_SOGoObject_H__
  23 #define __SoObjects_SOGoObject_H__
  24
  25 #import <Foundation/NSObject.h>
  26
  27 /*
  28   SOGoObject
  29
  30   This is the abstract class used by all SOGo SoObjects. It contains the
  31   ability to track a container as well as the key the object was invoked with.
  32
  33   In addition it provides some generic methods like user or group folder
  34   lookup.
  35 */
  36
  37 #import <NGObjWeb/SoObject.h>
  38
  39 @class NSString;
  40 @class NSArray;
  41 @class NSMutableString;
  42 @class NSException;
  43 @class NSTimeZone;
  44 @class NSURL;
  45
  46 @class WOContext;
  47 @class GCSFolderManager;
  48 @class GCSFolder;
  49
  50 @class SOGoUserFolder;
  51 @class SOGoGroupsFolder;
  52 @class SOGoDAVSet;
  53
  54 #define $(class) NSClassFromString(class)
  55
  56 @interface SOGoObject : NSObject
  57 {
  58   WOContext *context;
  59   NSString *nameInContainer;
  60   NSString *owner;
  61   id container;
  62 }
  63
  64 + (NSString *) globallyUniqueObjectId;
  65 - (NSString *) globallyUniqueObjectId;
  66
  67 + (id) objectWithName: (NSString *)_name inContainer:(id)_container;
  68
  69 - (id) initWithName: (NSString *) _name inContainer:(id)_container;
  70
  71 /* accessors */
  72
  73 - (NSString *) nameInContainer;
  74 - (id) container;
  75
  76 - (NSArray *) pathArrayToSOGoObject;
  77
  78 - (NSURL *) davURL;
  79 - (NSURL *) soURL;
  80 - (NSURL *) soURLToBaseContainerForUser: (NSString *) uid;
  81 - (NSURL *) soURLToBaseContainerForCurrentUser;
  82
  83 - (NSString *) labelForKey: (NSString *) key;
  84
  85 /* ownership */
  86
  87 - (void) setOwner: (NSString *) newOwner;
  88 - (NSString *) ownerInContext: (id) _ctx;
  89
  90 /* looking up shared objects */
  91
  92 - (SOGoUserFolder *) lookupUserFolder;
  93 - (SOGoGroupsFolder *) lookupGroupsFolder;
  94
  95 - (void) sleep;
  96
  97 /* hierarchy */
  98
  99 - (NSArray *) fetchSubfolders; /* uses toManyRelationshipKeys */
 100
 101 /* operations */
 102
 103 - (NSException *)delete;
 104 - (id)GETAction:(id)_ctx;
 105
 106 - (SOGoDAVSet *) davCurrentUserPrivilegeSet;
 107
 108 /* etag support */
 109
 110 - (NSException *) matchesRequestConditionInContext:(id)_ctx;
 111
 112 /* acls */
 113
 114 - (NSArray *) aclUsers;
 115 - (NSArray *) aclsForUser: (NSString *) uid;
 116 - (void) setRoles: (NSArray *) roles
 117           forUser: (NSString *) uid;
 118 - (void) removeAclsForUsers: (NSArray *) users;
 119 - (NSString *) defaultUserID;
 120
 121 - (void) sendACLAdditionAdvisoryToUser: (NSString *) uid;
 122 - (void) sendACLRemovalAdvisoryToUser: (NSString *) uid;
 123
 124 - (NSString *) httpURLForAdvisoryToUser: (NSString *) uid;
 125 - (NSString *) resourceURLForAdvisoryToUser: (NSString *) uid;
 126
 127 /* description */
 128
 129 - (void) appendAttributesToDescription:(NSMutableString *)_ms;
 130
 131 @end
 132
 133 #endif /* __SoObjects_SOGoObject_H__ */