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

   1 /*
   2   Copyright (C) 2000-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_SoLookupAssociation_H__
  23 #define __SoObjects_SoLookupAssociation_H__
  24
  25 #include <NGObjWeb/WOAssociation.h>
  26
  27 /*
  28   SoLookupAssociation
  29
  30   This association is experimental, behaviour isn't fixed yet.
  31   TODO: this should probably traverse relative to the clientObject, not to
  32         the component?!
  33         Or we might want to support keypath _and_ lookup path, like:
  34            "component.context.clientObject:+/abc/toolbar/"
  35
  36   Currently it traverses the path being passed in relative to the component:
  37     [_component traversePathArray:self->traversalPath
  38                 acquire:self->acquire];
  39
  40   If you prefix the path with a "+" acquisition will be turned on, eg:
  41     <var:string lookup:value="+toolbar/label" />
  42
  43   Namespace: http://www.skyrix.com/od/so-lookup
  44 */
  45
  46 @class NSArray;
  47
  48 @interface SoLookupAssociation : WOAssociation
  49 {
  50   NSArray *traversalPath;
  51   BOOL    acquire;
  52 }
  53
  54 /* accessors */
  55
  56 - (NSArray *)traversalPath;
  57 - (BOOL)doesAcquire;
  58
  59 /* value */
  60
  61 - (BOOL)isValueConstant; // returns NO
  62 - (BOOL)isValueSettable; // returns NO
  63
  64 @end
  65
  66 #endif /* __SoObjects_SoLookupAssociation_H__ */