err.no Git - sope/blob - sope-appserver/NGObjWeb/SoObjects/WOContext+SoObjects.h

   1 /*
   2   Copyright (C) 2002-2005 SKYRIX Software AG
   3
   4   This file is part of SOPE.
   5
   6   SOPE 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   SOPE 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 SOPE; 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_WOContext_SoObjects_H__
  23 #define __SoObjects_WOContext_SoObjects_H__
  24
  25 #include <NGObjWeb/WOContext.h>
  26
  27 /*
  28   WOContext(SoObjects)
  29
  30   The WOContext is the central access point for SOPE too. It has several new
  31   variables representing publishing state like the client object or the
  32   traversal path. You also access global SOPE objects using the context, for
  33   example the security manager.
  34 */
  35
  36 @class NSArray;
  37 @class SoSecurityManager, SoSubContext;
  38
  39 @interface WOContext(SoObjects)
  40
  41 /* security */
  42
  43 - (SoSecurityManager *)soSecurityManager;
  44
  45 /* traversal */
  46
  47 - (void)addObjectToTraversalStack:(id)_object;
  48 - (NSArray *)objectTraversalStack;
  49 - (id)traversalRoot;
  50
  51 - (void)setClientObject:(id)_object;
  52 - (id)clientObject;
  53
  54 - (void)setObjectDispatcher:(id)_dispatcher;
  55 - (id)objectDispatcher;
  56
  57 - (void)setSoRequestType:(NSString *)_rqType;
  58 - (NSString *)soRequestType;
  59 - (void)setSoRequestTraversalPath:(NSArray *)_path;
  60 - (NSArray *)soRequestTraversalPath;
  61
  62 - (void)setPathInfo:(NSString *)_pi;
  63 - (NSString *)pathInfo;
  64
  65 - (void)setRootURL:(NSString *)_url;
  66 - (NSString *)rootURL;
  67
  68 - (void)setObjectPermissionCache:(id)_cache;
  69 - (id)objectPermissionCache;
  70
  71 - (void)setActiveUser:(id)_user;
  72 - (id)activeUser;
  73
  74 /* subcontexts */
  75
  76 - (SoSubContext *)createSubContext;
  77 - (WOContext *)parentContext;
  78 - (WOContext *)rootContext;
  79
  80 @end
  81
  82 /* all the following methods are convenience methods that access WOContext */
  83
  84 #include <NGObjWeb/WOComponent.h>
  85 #include <NGObjWeb/WODirectAction.h>
  86
  87 @interface WOComponent(SoObjects)
  88 - (void)setClientObject:(id)_object;
  89 - (id)clientObject;
  90 @end
  91
  92 @interface WODirectAction(SoObjects)
  93 - (id)clientObject;
  94 @end
  95
  96 #endif /* __SoObjects_WOContext_SoObjects_H__ */