View Javadoc

1   /**
2    * Copyright (C) 2007 Joern Krueger surething@users.sourceforge.net
3    * 
4    * This program is free software; you can redistribute
5    * it and/or modify it under the terms of the GNU General
6    * Public License version 2 as published by the Free Software
7    * Foundation.
8    *
9    * This program is distributed in the hope that it will be
10   * useful, but WITHOUT ANY WARRANTY; without even the implied
11   * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12   * PURPOSE.  See the GNU General Public License for more
13   * details.
14   *
15   * You should have received a copy of the GNU General Public
16   * License along with this program; if not, write to the
17   * Free Software Foundation, Inc., 59 Temple Place,
18   * Suite 330, Boston, MA  02111-1307  USA
19   */
20  package de.surethingies.properties;
21  
22  public interface Parameter extends Comparable<Parameter>{
23  
24      /**
25       * @return The Group of this Key
26       */
27      public String getGroup();
28  
29      /**
30       * @return The Name of this Key
31       */
32      public String getIdentifier();
33  
34      /**
35       * The Property is Editable (and should perhaps be displaye inside a
36       * PropertyEditor)
37       * 
38       * @return true, if Property is editable
39       */
40      public boolean valueIsEditable();
41  
42      /**
43       * @return The Displayname of this Property
44       */
45      public String getDisplayName();
46  
47      /**
48       * @return The Parameters Default Value
49       */
50      public String getDefaultValue();
51  
52      /**
53       * @return The ValueType of this Property (STRING, TEXT...)
54       */
55      public ValueType valueType();
56      
57      /**
58       * @return An Ordering Integer Value
59       */
60      public int getOrder();
61  }