InterpretParameters


1   /**
2    * $Id: InterpretParameters.java 180 2007-03-15 12:56:38Z ssmc $
3    * Copyright 2005 iDare Media, Inc. All rights reserved.
4    *
5    * Originally written by iDare Media, Inc. for release into the public domain. This
6    * library, source form and binary form, is free software; you can redistribute it and/or
7    * modify it under the terms of the GNU Lesser General Public License (LGPL) as published
8    * by the Free Software Foundation; either version 2.1 of the License, or (at your option)
9    * any later version.<p>
10   *
11   * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
12   * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13   * See the GNU LGPL for more details.<p>
14   *
15   * You should have received a copy of the GNU Lesser General Public License along with this
16   * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite
17   * 330, Boston, MA  02111-1307  USA. The GNU LGPL can be found online at
18   * http://www.fsf.org/copyleft/lesser.html<p>
19   *
20   * This product has been influenced by several projects within the open-source community.
21   * The JWare developers wish to acknowledge the open-source community's support. For more
22   * information regarding the open-source products used within JWare, please visit the
23   * JWare website.
24   *----------------------------------------------------------------------------------------*
25   * WEBSITE- http://www.jware.info                            EMAIL- inquiries@jware.info
26   *----------------------------------------------------------------------------------------*
27   **/
28  
29  package com.idaremedia.antx.capture;
30  
31  import  java.util.Properties  ;
32  
33  import  com.idaremedia.antx.apis.Requester;
34  import  com.idaremedia.antx.parameters.IsA;
35  
36  /**
37   * Standard script-supplied instructions for a log interpretation request. An interpreter
38   * does not have to use all the options.
39   *
40   * @since     JWare/AntX 0.5
41   * @author    ssmc, &copy;2005 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
42   * @version   0.5
43   * @.safety   n/a
44   * @.group    impl,helper
45   * @see       InterpretLoggedTask
46   **/
47  
48  public interface InterpretParameters extends Requester
49  {
50      /**
51       * Returns <i>true</i> if the interpreter should update this
52       * requester's project directly. Usually returns <i>true</i>.
53       **/
54      boolean updateProperties();
55  
56  
57      /**
58       * Returns the maximum number of errors this interpreter will 
59       * tolerate before recording a failure. This value is zero (0)
60       * unless defined otherwise.
61       **/
62      int getMaxErrors();
63  
64  
65      /**
66       * Returns the maximum number of warnings this interpreter will
67       * tolerate before recording a failure. This value is ten (10)
68       * unless defined otherwise.
69       **/
70      int getMaxWarnings();
71  
72  
73      /**
74       * Returns the name of the property this interpreter will update
75       * with its conclusion. Never returns <i>null</i> or the empty 
76       * string.
77       **/
78      String   getUpdateProperty();
79  
80  
81      /**
82       * Returns the name of the property this interpreter will update
83       * with the number of errors. Never returns <i>null</i> or the 
84       * empty string.
85       **/
86      String   getErrorCountProperty();
87  
88  
89      /**
90       * Returns the name of the property this interpreter will update
91       * with the number of warnings. Never returns <i>null</i> or the
92       * empty string.
93       **/
94      String   getWarningCountProperty();
95  
96  
97  
98      /**
99       * Returns the preferred type of the result set data objects.
100      * Defaults to standard properties unless caller sets explicitly.
101      * Never returns <i>null</i>.
102      **/
103     IsA getResultType();
104 
105 
106 
107     /**
108      * Returns the readonly set of custom properties supplied by
109      * client script. Never returns <i>null</i> but can return an
110      * empty map.
111      **/
112     Properties   getInstructions();
113 }
114 
115 /* end-of-InterpretParameters.java */
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags