Module ch.ralscha.extdirectspring
Package ch.ralscha.extdirectspring.annotation

Enum Class ExtDirectMethodType

java.lang.Object
java.lang.Enum<ExtDirectMethodType>
ch.ralscha.extdirectspring.annotation.ExtDirectMethodType
All Implemented Interfaces:
Serializable, Comparable<ExtDirectMethodType>, Constable
public enum ExtDirectMethodType extends Enum<ExtDirectMethodType>
Enumeration of all possible remote method types.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    FORM_LOAD
    Specifies a method that handles a form load.
    FORM_POST
    Specifies a method that handles a form post (with or without upload).
    FORM_POST_JSON
    Specifies a method that handles a form post with a Json payload
    POLL
    Specifies a method that handles polling.
    SIMPLE
    Specifies a simple remote method.
    SIMPLE_NAMED
    Specifies a simple remote method with named parameters.
    STORE_MODIFY
    Specifies a method that handles create, update or destroy calls from DirectStore.
    STORE_READ
    Specifies a method that handles read calls from DirectStore.
    TREE_LOAD
    Specifies a method that handles read calls from TreeLoader or TreeStore

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract boolean
    isValid(String beanAndMethodName, Class<?> clazz, Method method)
    Checks if the annotated method contains non supported annotation properties and contains non supported parameters and/or parameter annotations.
    static ExtDirectMethodType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ExtDirectMethodType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • SIMPLE

      public static final ExtDirectMethodType SIMPLE
      Specifies a simple remote method. This type of method can have any parameter and any return type but must not contain a parameter with @RequestParam annotated.

    • SIMPLE_NAMED

      public static final ExtDirectMethodType SIMPLE_NAMED
      Specifies a simple remote method with named parameters. This type of method can have any parameter and any return type.

    • FORM_LOAD

      public static final ExtDirectMethodType FORM_LOAD
      Specifies a method that handles a form load.

    • STORE_READ

      public static final ExtDirectMethodType STORE_READ
      Specifies a method that handles read calls from DirectStore.

    • STORE_MODIFY

      public static final ExtDirectMethodType STORE_MODIFY
      Specifies a method that handles create, update or destroy calls from DirectStore.

    • FORM_POST

      public static final ExtDirectMethodType FORM_POST
      Specifies a method that handles a form post (with or without upload). A FORM_POST method must not return anything. This type of method must be annotated with @RequestMapping. @RequestMapping must contain a value and a method of type RequestMethod.POST. This kind of method must be member of a bean annotated with @Controller.

    • TREE_LOAD

      public static final ExtDirectMethodType TREE_LOAD
      Specifies a method that handles read calls from TreeLoader or TreeStore

    • POLL

      public static final ExtDirectMethodType POLL
      Specifies a method that handles polling.

    • FORM_POST_JSON

      public static final ExtDirectMethodType FORM_POST_JSON
      Specifies a method that handles a form post with a Json payload

  • Method Details

    • values

      public static ExtDirectMethodType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ExtDirectMethodType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • isValid

      public abstract boolean isValid(String beanAndMethodName, Class<?> clazz, Method method)
      Checks if the annotated method contains non supported annotation properties and contains non supported parameters and/or parameter annotations. Method logs warnings and errors. Check is running during startup of the application. If return value is false the method is not registered and cannot be called from the client.
      Parameters:
      beanAndMethodName - Name of the bean and method for logging purpose. e.g. 'bean.methodname'
      clazz - The class where the method is member of
      method - The annotated method
      Returns:
      true if the method does not contains any errors.