Package org.kuali.rice.krad.uif.lifecycle

Annotation Interface ViewLifecycleRestriction

@Target(METHOD) @Retention(RUNTIME) @Documented public @interface ViewLifecycleRestriction
Annotation for LifecycleElement bean properties to restrict which view lifecycle phases for which the property will be considered while initializing the successor phase queue.

This annotation should be placed on the read method for any properties on the component that should be excluded from the view lifecycle. An optional array of phases at which the property should be included may be provided.

Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    condition
    Expression to evaluate (must result in boolean) that will determine if the property is included at the configured phases.
    String[]
    exclude
    Lifecycle phase(s) at which to exclude the annotated bean property.
    String[]
    value
    Lifecycle phase (including preceding phases) at which to include the annotated bean property.

  • Element Details

    • value

      String[] value
      Lifecycle phase (including preceding phases) at which to include the annotated bean property.
      Returns:
      lifecycle phase at which to include the annotated property
      See Also:
      Default:
      {}

    • exclude

      String[] exclude
      Lifecycle phase(s) at which to exclude the annotated bean property.

      Note when this property is set by itself, all other phases not listed will be included. If value is set as well, only those phases within the value and not listed here will be included.

      Returns:
      set of lifecycle phases at which to exclude the annotated property
      See Also:
      Default:
      {}

    • condition

      String condition
      Expression to evaluate (must result in boolean) that will determine if the property is included at the configured phases.

      Expressions have access to the model as the default context. Also, no expression syntax (@{}) should be used.

      Returns:
      String condition to evaluate
      Default:
      ""