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


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

Declares that the annotated method will be used as a submission handler. The method should be in the format "doSubmissionName". The "do" prefix indicates that it's a submission handler and the rest of the method name will be used as the name of the submission (with a lower-cased initial character).

When the element is processed and a submission was received with the same name as the handler, the handler method will be executed instead of the "processElement" method.

Since:
1.5
Version:
$Revision: 3701 $
Author:
Geert Bevin (gbevin[remove] at uwyn dot com)
See Also:
Submission

Optional Element Summary
 SubmissionBean[] beans
          The submission's beans.
 SubmissionHandler.Continuations continuations
          Indicates whether the continuations should be preserved or cancelled when this submission is sent.
 FileRegexp[] fileRegexps
          The submission's regular expression file uploads.
 File[] files
          The submission's uploaded files.
 ParamRegexp[] paramRegexps
          The submission's regular expression parameters.
 Param[] params
          The submission's parameters.
 SubmissionHandler.Scope scope
          The submission's scope.
 

scope

public abstract SubmissionHandler.Scope scope
The submission's scope.

Since:
1.5
Default:
com.uwyn.rife.engine.annotations.SubmissionHandler.Scope.LOCAL

params

public abstract Param[] params
The submission's parameters.

Since:
1.5
Default:
{}

paramRegexps

public abstract ParamRegexp[] paramRegexps
The submission's regular expression parameters.

Since:
1.5
Default:
{}

beans

public abstract SubmissionBean[] beans
The submission's beans.

Since:
1.5
Default:
{}

files

public abstract File[] files
The submission's uploaded files.

Since:
1.5
Default:
{}

fileRegexps

public abstract FileRegexp[] fileRegexps
The submission's regular expression file uploads.

Since:
1.5
Default:
{}

continuations

public abstract SubmissionHandler.Continuations continuations
Indicates whether the continuations should be preserved or cancelled when this submission is sent.

Since:
1.6
Default:
com.uwyn.rife.engine.annotations.SubmissionHandler.Continuations.PRESERVE


Copyright © 2001-2007 Uwyn sprl/bvba. All Rights Reserved.