Package org.kuali.rice.krad.data.util

Annotation Interface Link

@Target({FIELD,TYPE}) @Retention(RUNTIME) public @interface Link
Specifies paths which should be linked during automatic reference linking processes.

If specified on a class, the path(s) will be relative to the class. If specified on a field, the path(s) will be relative to the field. If no paths are specified, then the linking will start at the class or field that is annotated.

To prevent cascading of reference linking, this annotation can be specified with cascade = false.

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

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    cascade
    Indicates whether or not linking should cascade through the specified path(s).
    String[]
    path
    Specify the path or paths (relative to the annotated class or field) at which to start the reference linking process.

  • Element Details

    • cascade

      boolean cascade
      Indicates whether or not linking should cascade through the specified path(s).
      Returns:
      true if reference linking should be cascaded, false otherwise
      Default:
      true

    • path

      String[] path
      Specify the path or paths (relative to the annotated class or field) at which to start the reference linking process. If no path specified, then linking will be performed on the annotated element and cascaded from there.
      Returns:
      the path or paths at which to start reference linking
      Default:
      {}