Package org.opencastproject.util.doc.rest

Annotation Interface RestParameter

@Retention(RUNTIME) public @interface RestParameter
This annotation type is used for annotating parameters for RESTful query. This annotation type needs to be kept until runtime.

  • Element Details

    • name

      String name
      Returns:
      a name of the parameter.

    • description

      String description
      Returns:
      a description of the parameter.

    • defaultValue

      String defaultValue
      Returns:
      a default value of the parameter.
      Default:
      ""

    • type

      RestParameter.Type type
      Returns:
      a RestParameter.Type enum specifying the type of the parameter.

    • jaxbClass

      Class<?> jaxbClass
      Returns:
      the XmlType or XmlRootElement annotated class that models this parameter.
      Default:
      java.lang.Object.class

    • isRequired

      boolean isRequired
      Returns:
      a boolean indicating whether this parameter is required.