err.no Git - sope/blob - sope-core/NGExtensions/NGExtensions/NGRuleModel.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 __NGRuleEngine_NGRuleModel_H__
  23 #define __NGRuleEngine_NGRuleModel_H__
  24
  25 #import <Foundation/NSObject.h>
  26 #import <EOControl/EOKeyValueArchiver.h>
  27
  28 /*
  29   NGRuleModel
  30
  31   A rule model is a specialized sequence of rules.
  32 */
  33
  34 // TODO: need some method to join two models (two allow one model being
  35 //       configured as a default but still have fallback rules in another)
  36
  37 @class NSArray, NSMutableArray, NSURL;
  38 @class NGRule;
  39
  40 @interface NGRuleModel : NSObject < EOKeyValueArchiving >
  41 {
  42   NSMutableArray *rules;
  43 }
  44
  45 + (id)ruleModelWithPropertyList:(id)_plist;
  46 + (id)ruleModelWithContentsOfUserDefault:(NSString *)_defName;
  47
  48 - (id)init;
  49 - (id)initWithRules:(NSArray *)_rules;
  50 - (id)initWithPropertyList:(id)_plist;
  51 - (id)initWithContentsOfFile:(NSString *)_path;
  52 - (id)initWithContentsOfUserDefault:(NSString *)_defaultName;
  53 - (id)initWithKeyValueArchiveAtURL:(NSURL *)_url;
  54
  55 /* accessors */
  56
  57 - (void)setRules:(NSArray *)_rules;
  58 - (NSArray *)rules;
  59 - (void)addRule:(NGRule *)_rule;
  60 - (void)removeRule:(NGRule *)_rule;
  61 - (void)addRules:(NSArray *)_rules;
  62
  63 /* operations */
  64
  65 - (NSArray *)candidateRulesForKey:(NSString *)_key;
  66
  67 @end
  68
  69 #endif /* __NGRuleEngine_NGRuleModel_H__ */