KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jaspersoft > jasperserver > api > metadata > common > domain > InputControl


1 /*
2  * Copyright (C) 2006 JasperSoft http://www.jaspersoft.com
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed WITHOUT ANY WARRANTY; and without the
10  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11  * See the GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, see http://www.gnu.org/licenses/gpl.txt
15  * or write to:
16  *
17  * Free Software Foundation, Inc.,
18  * 59 Temple Place - Suite 330,
19  * Boston, MA USA 02111-1307
20  */
21 package com.jaspersoft.jasperserver.api.metadata.common.domain;
22
23 import java.util.List JavaDoc;
24
25
26
27 /**
28  * @author Teodor Danciu (teodord@users.sourceforge.net)
29  * @version $Id: InputControl.java 4472 2006-09-08 14:16:36Z lucian $
30  */
31 public interface InputControl extends Resource
32 {
33
34     /**
35      *
36      */
37     public static final byte TYPE_BOOLEAN = 1;
38     public static final byte TYPE_SINGLE_VALUE = 2;
39     public static final byte TYPE_SINGLE_SELECT_LIST_OF_VALUES = 3;
40     public static final byte TYPE_SINGLE_SELECT_QUERY = 4;
41     public static final byte TYPE_MULTI_VALUE = 5;
42     public static final byte TYPE_MULTI_SELECT_LIST_OF_VALUES = 6;
43     public static final byte TYPE_MULTI_SELECT_QUERY = 7;
44     public static final byte TYPE_SINGLE_SELECT_LIST_OF_VALUES_RADIO = 8;
45     public static final byte TYPE_SINGLE_SELECT_QUERY_RADIO = 9;
46     public static final byte TYPE_MULTI_SELECT_LIST_OF_VALUES_CHECKBOX = 10;
47     public static final byte TYPE_MULTI_SELECT_QUERY_CHECKBOX = 11;
48
49
50     /**
51      *
52      */
53     public byte getType();
54
55     /**
56      *
57      */
58     public void setType(byte type);
59
60     /**
61      *
62      */
63     public boolean isMandatory();
64
65     /**
66      *
67      */
68     public void setMandatory(boolean isMandatory);
69
70     /**
71      *
72      */
73     public boolean isReadOnly();
74
75     /**
76      *
77      */
78     public void setReadOnly(boolean isReadOnly);
79
80     /**
81      * Returns the reference to the
82      * {@link DataType data type}
83      * of this input control.
84      *
85      * @return a reference to the data type used by this input control
86      */
87     public ResourceReference getDataType();
88
89     /**
90      *
91      */
92     public void setDataType(ResourceReference dataTypeReference);
93     
94     public void setDataType(DataType dataType);
95     
96     public void setDataTypeReference(String JavaDoc referenceURI);
97
98     /**
99      * Returns the reference to the
100      * {@link ListOfValues list of values}
101      * used by this input control.
102      *
103      * @return a reference to the list of values used by this input control
104      */
105     public ResourceReference getListOfValues();
106
107     /**
108      *
109      */
110     public void setListOfValues(ResourceReference listOfValuesReference);
111     
112     public void setListOfValues(ListOfValues listOfValues);
113     
114     public void setListOfValuesReference(String JavaDoc referenceURI);
115
116     /**
117      * Returns the reference to the
118      * {@link Query query}
119      * used by this input control.
120      *
121      * @return a reference to the query used by this input control
122      */
123     public ResourceReference getQuery();
124
125     /**
126      *
127      */
128     public void setQuery(ResourceReference query);
129
130     public void setQuery(Query query);
131
132     public void setQueryReference(String JavaDoc referenceURI);
133
134     /**
135      *
136      */
137     public String JavaDoc[] getQueryVisibleColumns();
138
139     /**
140      *
141      */
142     public void addQueryVisibleColumn(String JavaDoc column);
143
144     /**
145      *
146      */
147     public void removeQueryVisibleColumn(String JavaDoc column);
148
149     /**
150      *
151      */
152     public String JavaDoc getQueryValueColumn();
153
154     /**
155      *
156      */
157     public void setQueryValueColumn(String JavaDoc column);
158
159     /**
160      *
161      */
162     public Object JavaDoc getDefaultValue();
163
164     /**
165      *
166      */
167     public void setDefaultValue(Object JavaDoc value);
168
169     /**
170      *
171      */
172     public List JavaDoc getDefaultValues();
173
174     /**
175      *
176      */
177     public void setDefaultValues(List JavaDoc values);
178
179     /**
180      *
181      */
182     public List JavaDoc getQueryVisibleColumnsAsList();
183 }
184
Popular Tags