com.uwyn.rife.engine.annotations
Annotation Type SubmissionBeanProperty

@Retention(value=RUNTIME)
@Target(value=METHOD)
@Documented
public @interface SubmissionBeanProperty

Declares that the bean property that corresponds to the annotated setter will be used as a submission bean. The name of the bean will be the name of the property, and the bean class will be the property type. The submission bean will be added to the previous submission that has been declared.

If no submission has been declared beforehand, either through Submission or SubmissionHandler, an exception will be thrown when the annotations of this element are evaluated.

When an element is processed, an instance of the submission bean will be created and its properties will be filled in with the available submission parameter values. The submission bean instance will be injected into the element through the setter and RIFE's type conversion will try to convert the bean type into the property type. A NamedSubmissionBeanInjectionException exception will be thrown if the conversion failed.

Since:

1.5

Version:

$Revision: 3687 $

Author:

Geert Bevin (gbevin[remove] at uwyn dot com)

See Also:

SubmissionBean, Submission, SubmissionHandler

Optional Element Summary

String	group The validation group that has been declared by the bean class.
String	name The expected name of the property.
String	prefix The prefix that will be prepended to each property name of the submission bean when corresponding parameters are automatically declared.

name

public abstract String name

The expected name of the property.

This hasn't got any influence on the actual name that is being used for the property, but is used instead to ensure that the property name is the same as the one specified here. This is typically used to create a single point of declaration for the property name that can be referenced elsewhere and that is ensured to be correct.

Since:

1.6

Default:

""

prefix

public abstract String prefix

The prefix that will be prepended to each property name of the submission bean when corresponding parameters are automatically declared.

Since:

1.5

Default:

""

group

public abstract String group

The validation group that has been declared by the bean class.

This requires the bean class to implement the ValidatedConstrained interface, either directly, or by extending MetaData, or by using automated meta data merging.

The group will indicate which bean properties should only be taken into account. Any properties outside the group will not be created as submission parameters.

Since:

1.5

Default:

""