org.apache.beehive.netui.pageflow.annotations
Annotation Type Jpf.SimpleAction


@Target(value=ANNOTATION_TYPE)
@Retention(value=RUNTIME)
public static @interface Jpf.SimpleAction


Required Element Summary
 String name
          name (required)
 
Optional Element Summary
 String action
          An action to forward to.
 Jpf.Catch[] catches
          exception catches (optional )
 Jpf.ConditionalForward[] conditionalForwards
           
 boolean doValidation
          Turn form validation on or off for this action.
 boolean externalRedirect
           
 String forwardRef
          The name of a class-level forward (Jpf.ConditionalForward).
 boolean loginRequired
          is login required to access this action (optional )
 Jpf.NavigateTo navigateTo
          A symbolic name for the page/action to which to navigate.
 String outputFormBean
           
 Class outputFormBeanType
           
 String path
          The forward path.
 boolean preventDoubleSubmit
          Prevent multiple submits to this action.
 boolean readOnly
          is this action read-only, i.e., is it guaranteed not to modify member state (optional )
 boolean redirect
           
 boolean restoreQueryString
          Tells whether the original query string will be restored on a rerun of a previous action.
 String returnAction
          The action to be invoked on the calling page flow.
 String[] rolesAllowed
          roles allowed to access this action (optional )
 String tilesDefinition
          A Tiles definition to forward to.
 String useFormBean
          page flow-scoped form; references a member variable (bean) in the page flow (optional )
 Class useFormBeanType
          the type of form bean to use for this action (optional )
 Jpf.ValidatableProperty[] validatableProperties
          field-level validation rules tied to the action (optional )
 Jpf.Forward validationErrorForward
          forward used when validation fails
 

Element Detail

name

public abstract String name
name (required)

conditionalForwards

public abstract Jpf.ConditionalForward[] conditionalForwards
Default:
{}

useFormBean

public abstract String useFormBean
page flow-scoped form; references a member variable (bean) in the page flow (optional )

Default:
""

useFormBeanType

public abstract Class useFormBeanType
the type of form bean to use for this action (optional )

Default:
java.lang.Void.class

readOnly

public abstract boolean readOnly
is this action read-only, i.e., is it guaranteed not to modify member state (optional )

Default:
false

rolesAllowed

public abstract String[] rolesAllowed
roles allowed to access this action (optional )

Default:
{}

loginRequired

public abstract boolean loginRequired
is login required to access this action (optional )

Default:
false

catches

public abstract Jpf.Catch[] catches
exception catches (optional )

Default:
{}

validatableProperties

public abstract Jpf.ValidatableProperty[] validatableProperties
field-level validation rules tied to the action (optional )

Default:
{}

validationErrorForward

public abstract Jpf.Forward validationErrorForward
forward used when validation fails

Default:
@org.apache.beehive.netui.pageflow.annotations.Jpf.Forward(name="")

doValidation

public abstract boolean doValidation
Turn form validation on or off for this action. If validationErrorForward() is not empty, this value is set to trueautomatically.

Default:
false

path

public abstract String path
The forward path. Mutually-exclusive with navigateTo(), returnAction(), action(), tilesDefinition(), and forwardRef().

Default:
""

returnAction

public abstract String returnAction
The action to be invoked on the calling page flow. Mutually-exclusive with path(), navigateTo(), action(), tilesDefinition(), and forwardRef(), and only valid in a nested page flow (Jpf.Controller.nested() must be true).

Default:
""

navigateTo

public abstract Jpf.NavigateTo navigateTo
A symbolic name for the page/action to which to navigate. Mutually-exclusive with path(), returnAction(), action(), tilesDefinition(), and forwardRef()..

Default:
currentPage

action

public abstract String action
An action to forward to. Mutually-exclusive with path(), navigateTo(), returnAction(), tilesDefinition(), and forwardRef()..

Default:
""

tilesDefinition

public abstract String tilesDefinition
A Tiles definition to forward to. Mutually-exclusive with path(), navigateTo(), returnAction(), action(), and forwardRef()..

Default:
""

forwardRef

public abstract String forwardRef
The name of a class-level forward (Jpf.ConditionalForward). Mutually-exclusive with with path(), navigateTo(), returnAction(), tilesDefinition(), and forwardRef().

Default:
""

restoreQueryString

public abstract boolean restoreQueryString
Tells whether the original query string will be restored on a rerun of a previous action. Only valid when navigateTo is NavigateTo.previousAction.

Returns:
boolean
Default:
false

outputFormBeanType

public abstract Class outputFormBeanType
Default:
java.lang.Void.class

outputFormBean

public abstract String outputFormBean
Default:
""

redirect

public abstract boolean redirect
Default:
false

externalRedirect

public abstract boolean externalRedirect
Default:
false

preventDoubleSubmit

public abstract boolean preventDoubleSubmit
Prevent multiple submits to this action. If multiple submits occur, a DoubleSubmitException is thrown.

Default:
false