Package com.carfey.ops.job.param

Annotation Type Parameter

  • @Target(ANNOTATION_TYPE)
@Documented
@Retention(RUNTIME)
public @interface Parameter
    Used to define parameters used by a SchedulableJob implementation via the Configuration annotation. Defined parameters will be collected and validated when a job configuration is saved or the job is executed.

    For customized validation, use ConfigValidatingJob. To generate parameters dynamically, use ConfigGeneratingJob.

    • Element Detail

      • name

        java.lang.String name
        Returns:
        unique name for the parameter

      • required

        boolean required
        Returns:
        if a value must be configured for this parameter

      • requiredAtRuntime

        boolean requiredAtRuntime
        Returns:
        if a value must be configured for this parameter when submitted for ad-hoc execution. Being specified on the scheduled job meets this requirement.
        Default:
        false

      • type

        Type type
        Returns:
        the type of the paramter which restricts valid values
        Default:
        com.carfey.ops.job.param.Type.STRING

      • allowMultiple

        boolean allowMultiple
        Returns:
        should multiple values be allowed?
        Default:
        false

      • defaultValue

        java.lang.String defaultValue
        Returns:
        the default value to use when none are supplied
        Default:
        ""

      • listProvider

        java.lang.Class<? extends ListProvider> listProvider
        Used with listArgs()
        Returns:
        the ListProvider implementation used to enumerate valid values.
        Default:
        com.carfey.ops.job.param.StaticListProvider.class

      • description

        java.lang.String description
        A description of the parameter in the same vein as Description that will provide guidance in the user interface.
        Returns:
        The textual description to show in the UI.
        Since:
        4.0.2
        Default:
        ""

      • urls

        java.lang.String[] urls
        If specified, these values will be output as hyperlinks in the user interface. Used as a convenience mechanism to link to more extensive documentation about the job parameter.
        Since:
        4.9.0
        Default:
        {}

      • requireUniqueSelection

        boolean requireUniqueSelection
        Returns:
        if multiples allowed, should Obsidian enforce each value only occurs once?
        Since:
        4.10.0
        Default:
        false