Package com.polarion.platform.jobs

Interface IJobDescriptor.IJobParameter

All Known Implementing Classes:
AbstractJobParameter, ArrayJobParameter, BuildArtifactJobParameter, LocationJobParameter, PathJobParameter, PropertiesJobParameter, SimpleJobParameter
Enclosing interface:
IJobDescriptor
public static interface IJobDescriptor.IJobParameter
Job parameter descriptor.
Author:
Stepan Roh, Polarion Software

  • Method Details

    • getGroup

      IJobDescriptor.IJobParameterGroup getGroup()
      Parent group.

      Protected from dynamic change.

      Returns:
      parameter group (not null)

    • getName

      String getName()
      Name.

      Unique within one job descriptor.

      Protected from dynamic change.

      Returns:
      name (not null)

    • getLabel

      String getLabel()
      Human-readable label.
      Returns:
      label (not null)

    • getDescription

      String getDescription()
      Human-readable description (if any).
      Returns:
      description or null

    • getType

      IJobDescriptor.IJobParameterType getType()
      Type.

      Protected from dynamic change.

      Returns:
      type (not null)

    • isRequired

      boolean isRequired()
      Whether this parameter is required.

      Only relevant if isActive() is true.

      Returns:
      true if parameter is required, false otherwise

    • isActive

      boolean isActive()
      Whether this parameter is active.

      (In)activity is used in dynamic descriptors to mark configuration currently unnecessary.

      Returns:
      true if this parameter is active, false otherwise

    • getDefaultValue

      Object getDefaultValue()
      Default value.
      Returns:
      default value or null

    • convertValue

      Object convertValue(Object value)
      Helper method for conversion from arbitrary Object to desired class.

      It is not required that null is converted to null or that non-null is not converted to null.

      Parameters:
      value - arbitrary value (may be null)
      Returns:
      converted value or null
      Throws:
      IllegalArgumentException - if value can not be converted