Annotation Type EdmAction


@Retention(RUNTIME) @Target(METHOD) public @interface EdmAction
Metadata of an action, see edm:Action.

Author:
Oliver Grande
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Bound actions that return an entity or a collection of entities MAY specify a value for the EntitySetPath attribute if determination of the entity set for the return type is contingent on the binding parameter.
    boolean
    Indicates that the action is bound.
    Defines the name of the action.
    Define additional facet information for the return type of an action
  • Element Details

    • name

      String name
      Defines the name of the action. If not given, the Java method name is taken.
      Returns:
      action name
      Default:
      ""
    • returnType

      Define additional facet information for the return type of an action
      Returns:
      return type of this action
      Default:
      @com.sap.olingo.jpa.metadata.core.edm.annotation.EdmFunction.ReturnType
    • isBound

      boolean isBound
      Indicates that the action is bound. Default is false.

      Unbound actions are invoked through an action import. Bound actions are invoked by appending a segment containing the qualified action name to a segment of the appropriate binding parameter type within the resource path. For details see: OData Version 4.0 Part 3 - 12.1.2 Attribute IsBound

      Returns:
      is action bounding
      Default:
      false
    • entitySetPath

      String entitySetPath
      Bound actions that return an entity or a collection of entities MAY specify a value for the EntitySetPath attribute if determination of the entity set for the return type is contingent on the binding parameter. See: OData Version 4.0 Part 3 - 12.1.3 Attribute EntitySetPath

      Returns:
      path of entity
      Default:
      ""