Package com.mayam.wf.attributes.shared

Annotation Interface Declare

@Documented @Retention(RUNTIME) @Target(FIELD) public @interface Declare
Describes the purpose of an Attribute, used to establish how to use it and in which context, and specifies the class allowed for values.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    purpose
    The purpose of the attribute as told to developers, integrators and administrators.
    Class<?>
    valueClass
    The class used for values of the attribute.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    internal
    If true, attribute is for internal use only and not exposed through SOAP, REST or messaging.
    Scope
    scope
    Usage scope of the attribute.
    Variety
    variety
    Optional Variety used to narrow down the use of a generic/primitive value class.

  • Element Details

    • purpose

      String purpose
      The purpose of the attribute as told to developers, integrators and administrators.

    • valueClass

      Class<?> valueClass
      The class used for values of the attribute.

    • variety

      Variety variety
      Optional Variety used to narrow down the use of a generic/primitive value class.
      Default:
      NONE

    • scope

      Scope scope
      Usage scope of the attribute.
      Default:
      DETAIL

    • internal

      boolean internal
      If true, attribute is for internal use only and not exposed through SOAP, REST or messaging.
      Default:
      false