src/core/net/sf/basedb/util/overview/extensions/ValidationRuleAction.java

Code
Comments
Other
Rev Date Author Line
6047 18 Apr 12 nicklas 1 /**
6047 18 Apr 12 nicklas 2   $Id$
6047 18 Apr 12 nicklas 3
6047 18 Apr 12 nicklas 4   Copyright (C) 2012 Nicklas Nordborg
6047 18 Apr 12 nicklas 5
6047 18 Apr 12 nicklas 6   This file is part of BASE - BioArray Software Environment.
6047 18 Apr 12 nicklas 7   Available at http://base.thep.lu.se/
6047 18 Apr 12 nicklas 8
6047 18 Apr 12 nicklas 9   BASE is free software; you can redistribute it and/or
6047 18 Apr 12 nicklas 10   modify it under the terms of the GNU General Public License
6047 18 Apr 12 nicklas 11   as published by the Free Software Foundation; either version 3
6047 18 Apr 12 nicklas 12   of the License, or (at your option) any later version.
6047 18 Apr 12 nicklas 13
6047 18 Apr 12 nicklas 14   BASE is distributed in the hope that it will be useful,
6047 18 Apr 12 nicklas 15   but WITHOUT ANY WARRANTY; without even the implied warranty of
6047 18 Apr 12 nicklas 16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
6047 18 Apr 12 nicklas 17   GNU General Public License for more details.
6047 18 Apr 12 nicklas 18
6047 18 Apr 12 nicklas 19   You should have received a copy of the GNU General Public License
6047 18 Apr 12 nicklas 20   along with BASE. If not, see <http://www.gnu.org/licenses/>.
6047 18 Apr 12 nicklas 21 */
6047 18 Apr 12 nicklas 22 package net.sf.basedb.util.overview.extensions;
6047 18 Apr 12 nicklas 23
6047 18 Apr 12 nicklas 24 import net.sf.basedb.util.extensions.Action;
6047 18 Apr 12 nicklas 25 import net.sf.basedb.util.overview.Severity;
6047 18 Apr 12 nicklas 26 import net.sf.basedb.util.overview.Validator;
6047 18 Apr 12 nicklas 27
6047 18 Apr 12 nicklas 28 /**
6047 18 Apr 12 nicklas 29   The same as a Validator. The Action interface provides the 
6047 18 Apr 12 nicklas 30   possibility to link with the extension system.
6047 18 Apr 12 nicklas 31   
6047 18 Apr 12 nicklas 32   @author nicklas
6047 18 Apr 12 nicklas 33   @since 3.2
6047 18 Apr 12 nicklas 34   @see Validator
6047 18 Apr 12 nicklas 35 */
6047 18 Apr 12 nicklas 36 public interface ValidationRuleAction
6047 18 Apr 12 nicklas 37   extends Action
6047 18 Apr 12 nicklas 38 {
6047 18 Apr 12 nicklas 39
6047 18 Apr 12 nicklas 40   
6047 18 Apr 12 nicklas 41   /**
6047 18 Apr 12 nicklas 42     Get the unique ID of this validation rule.
6047 18 Apr 12 nicklas 43   */
6047 18 Apr 12 nicklas 44   public String getId();
6047 18 Apr 12 nicklas 45   
6047 18 Apr 12 nicklas 46   /**
6047 18 Apr 12 nicklas 47     Get the title of this validator rule.
6047 18 Apr 12 nicklas 48   */
6047 18 Apr 12 nicklas 49   public String getTitle();
6047 18 Apr 12 nicklas 50   
6047 18 Apr 12 nicklas 51   /**
6047 18 Apr 12 nicklas 52     Get a lengthier description of the validation that takes place
6047 18 Apr 12 nicklas 53   */
6047 18 Apr 12 nicklas 54   public String getDescription();
6047 18 Apr 12 nicklas 55   
6047 18 Apr 12 nicklas 56   /**
6047 18 Apr 12 nicklas 57     Get a short summary that is displayed when the validation fails
6047 18 Apr 12 nicklas 58   */
6047 18 Apr 12 nicklas 59   public String getFailureSummary();
6047 18 Apr 12 nicklas 60   
6047 18 Apr 12 nicklas 61   /**
6047 18 Apr 12 nicklas 62     Get the default severity level.
6047 18 Apr 12 nicklas 63   */
6047 18 Apr 12 nicklas 64   public Severity getDefaultSeverity();
6047 18 Apr 12 nicklas 65   
6047 18 Apr 12 nicklas 66   
6047 18 Apr 12 nicklas 67 }