1 package net.sf.mmapps.modules.config;
2
3 import java.util.Properties;
4 /***
5 * very simple java interface representing
6 * the configuration of a field
7 * @author Kees Jongenburger
8 * @version $Id: FieldConfiguration.java,v 1.2 2004/05/18 13:53:55 keesj Exp $
9 **/
10 public interface FieldConfiguration{
11 /***
12 * @return a human readable fieldname
13 **/
14 public String getGUIName(String lang);
15 public void setGUIName(String lang,String value);
16
17
18 public Properties getGUINames();
19 /***
20 * @return the name of the field
21 **/
22 public String getName();
23 public void setName(String name);
24
25 /***
26 * @return the descriptions of the fields
27 **/
28 public Properties getDescriptions();
29
30 /***
31 * @return the description of the fields in a certain language
32 **/
33 public String getDescription(String lang);
34 public void setDescription(String lang,String value);
35
36 /***
37 * @return the mmbase-type of the field
38 **/
39 public String getType();
40 public void setType(String type);
41
42 /***
43 * @return the mmbase-state of the field
44 **/
45 public String getState();
46 public void setState(String state);
47
48 /***
49 * @return the if the field is a key
50 **/
51 public boolean isKey();
52 public void setIsKey(boolean iskey);
53
54 /***
55 * @return the if the field may be null
56 **/
57 public boolean isNotNull();
58 public void setIsNotNull(boolean isNotNull);
59
60 /***
61 * @return the doctype of the field (only for xml types)
62 **/
63 public String getDocType();
64 public void setDocType(String doctype);
65
66 /***
67 * if applicable this methods returns the size of the field
68 * @return the size of the field
69 **/
70 public String getSize();
71 public void setSize(String size);
72
73 /***
74 * some applications need to know how to display the field
75 * this method returns a "hint" on how to display the field
76 * @return a "hint" on howto display a field
77 **/
78 public String getGUIType();
79 public void setGUIType(String guitype);
80
81 public String getEditorPosition();
82 public void setEditorPosition(String pos);
83 public String getSearchPosition();
84 public void setSearchPosition(String pos);
85 public String getListPosition();
86 public void setListPosition(String pos);
87 }