err.no Git - scalable-opengroupware.org/blob - SOGo/SoObjects/SOGo/SOGoObject.h

   1 /*
   2   Copyright (C) 2004 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 // $Id$
  22
  23 #ifndef __SoObjects_SOGoObject_H__
  24 #define __SoObjects_SOGoObject_H__
  25
  26 #import <Foundation/NSObject.h>
  27
  28 /*
  29   SOGoObject
  30
  31   This is the abstract class used by all SOGo SoObjects. It contains the
  32   ability to track a container as well as the key the object was invoked with.
  33
  34   In addition it provides some generic methods like user or group folder
  35   lookup.
  36 */
  37
  38 @class NSString, NSArray, NSMutableString, NSException;
  39 @class OCSFolderManager, OCSFolder;
  40 @class SOGoUserFolder, SOGoGroupsFolder;
  41
  42 @interface SOGoObject : NSObject
  43 {
  44   NSString *nameInContainer;
  45   id       container;
  46 }
  47
  48 - (id)initWithName:(NSString *)_name inContainer:(id)_container;
  49
  50 /* accessors */
  51
  52 - (NSString *)nameInContainer;
  53 - (id)container;
  54
  55 /* ownership */
  56
  57 - (NSString *)ownerInContext:(id)_ctx;
  58
  59 /* looking up shared objects */
  60
  61 - (SOGoUserFolder *)lookupUserFolder;
  62 - (SOGoGroupsFolder *)lookupGroupsFolder;
  63
  64 - (void)sleep;
  65
  66 /* hierarchy */
  67
  68 - (NSArray *)fetchSubfolders; /* uses toManyRelationshipKeys */
  69
  70 /* operations */
  71
  72 - (NSException *)delete;
  73
  74 /* description */
  75
  76 - (void)appendAttributesToDescription:(NSMutableString *)_ms;
  77
  78 @end
  79
  80 #endif /* __SoObjects_SOGoObject_H__ */