1 /*
2 * Copyright (c) 2001 - 2005 ivata limited.
3 * All rights reserved.
4 * -----------------------------------------------------------------------------
5 * ivata masks may be redistributed under the GNU General Public
6 * License as published by the Free Software Foundation;
7 * version 2 of the License.
8 *
9 * These programs are free software; you can redistribute them and/or
10 * modify them under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; version 2 of the License.
12 *
13 * These programs are distributed in the hope that they will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16 *
17 * See the GNU General Public License in the file LICENSE.txt for more
18 * details.
19 *
20 * If you would like a copy of the GNU General Public License write to
21 *
22 * Free Software Foundation, Inc.
23 * 59 Temple Place - Suite 330
24 * Boston, MA 02111-1307, USA.
25 *
26 *
27 * To arrange commercial support and licensing, contact ivata at
28 * http://www.ivata.com/contact.jsp
29 * -----------------------------------------------------------------------------
30 * $Log: Mask.java,v $
31 * Revision 1.6 2005/04/11 12:27:03 colinmacleod
32 * Added preliminary support for filters.
33 * Added FieldValueConvertor factor interface
34 * to split off value convertors for reuse.
35 *
36 * Revision 1.5 2005/04/09 18:04:14 colinmacleod
37 * Changed copyright text to GPL v2 explicitly.
38 *
39 * Revision 1.4 2005/01/19 12:39:39 colinmacleod
40 * Changed Id --> Name.
41 *
42 * Revision 1.3 2005/01/06 22:13:21 colinmacleod
43 * Moved up a version number.
44 * Changed copyright notices to 2005.
45 * Updated the documentation:
46 * - started working on multiproject:site docu.
47 * - changed the logo.
48 * Added checkstyle and fixed LOADS of style issues.
49 * Added separate thirdparty subproject.
50 * Added struts (in web), util and webgui (in webtheme) from ivata op.
51 *
52 * Revision 1.2 2004/12/30 20:15:14 colinmacleod
53 * Moved first and last fields up to Group from Mask.
54 *
55 * Revision 1.1 2004/12/29 20:07:06 colinmacleod
56 * Renamed subproject masks to mask.
57 *
58 * Revision 1.1.1.1 2004/05/16 20:40:31 colinmacleod
59 * Ready for 0.1 release
60 * -----------------------------------------------------------------------------
61 */
62 package com.ivata.mask;
63 import java.util.List;
64 import com.ivata.mask.group.Group;
65 /***
66 * Defines a single mask for display.
67 *
68 * @author Colin MacLeod
69 * @since ivata masks 0.1 (2004-05-15) <a
70 * href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com </a>
71 */
72 public interface Mask extends Group {
73 /***
74 * <p>
75 * Get the dependent object class associated with this mask.
76 * </p>
77 *
78 * @return The dependent object class associated with this mask.
79 */
80 Class getDOClass();
81 /***
82 * <p>
83 * Get all the fields to be displayed in this mask.
84 * </p>
85 *
86 * @return All the fields to be displayed in this mask as a
87 * <code>List</code> of <code>Field</code> instances.
88 */
89 List getFields();
90 /***
91 * For masks, you can include non-dynamically generated field layouts. In
92 * a web-app these paths equate to a <strong>Struts</strong> action forward,
93 * used in a <jsp:include...> tag.
94 *
95 * @return a list of all static fields included in the mask.
96 */
97 List getIncludePaths();
98 }