01: /*
02: * Copyright 2001-2007 Geert Bevin <gbevin[remove] at uwyn dot com>
03: * Distributed under the terms of either:
04: * - the common development and distribution license (CDDL), v1.0; or
05: * - the GNU Lesser General Public License, v2.1 or later
06: * $Id: SubmissionBean.java 3634 2007-01-08 21:42:24Z gbevin $
07: */
08: package com.uwyn.rife.engine.annotations;
09:
10: import java.lang.annotation.Documented;
11: import java.lang.annotation.Retention;
12: import java.lang.annotation.RetentionPolicy;
13: import java.lang.annotation.Target;
14:
15: /**
16: * Declares a submission bean.
17: *
18: * @author Geert Bevin (gbevin[remove] at uwyn dot com)
19: * @version $Revision: 3634 $
20: * @since 1.5
21: * @see SubmissionBeanProperty
22: */
23: @Retention(RetentionPolicy.RUNTIME)
24: @Target({})
25: @Documented
26: public @interface SubmissionBean {
27: /**
28: * The class of the submission bean.
29: * @since 1.5
30: */
31: Class beanclass();
32:
33: /**
34: * The prefix that will be prepended to each property name of the
35: * submission bean when corresponding parameters are automatically
36: * declared.
37: * @since 1.5
38: */
39: String prefix() default "";
40:
41: /**
42: * The name of the submission bean.
43: * @since 1.5
44: */
45: String name() default "";
46:
47: /**
48: * The validation group that has been declared by the bean class.
49: * <p>This requires the bean class to implement the {@link com.uwyn.rife.site.ValidatedConstrained}
50: * interface, either directly, or by extending {@link com.uwyn.rife.site.MetaData}, or by using
51: * automated <a href="http://rifers.org/wiki/display/RIFE/Meta+data+merging">meta data merging</a>.
52: * <p>The group will indicate which bean properties should only be taken
53: * into account. Any properties outside the group will not be created as
54: * submission parameters.
55: * @since 1.5
56: */
57: String group() default "";
58: }
|