Interface FieldConfigurations.FieldConfiguration

All Known Implementing Classes:
FieldConfigurationsImpl
Enclosing interface:
FieldConfigurations

public static interface FieldConfigurations.FieldConfiguration
Represents a field configuration that actions can be carried out on
  • Method Details

    • showField

      void showField(int id)
      Deprecated.
      since 4.2. This method is not future-proof; as fields get added to configurations, the 'id' sequence might change for the field you intended to use. Use showFields(String) instead.
      Parameters:
      id - the sequence of the field you want to show in the Field Configuration screen
    • hideField

      void hideField(int id)
      Deprecated.
      since 4.2. This method is not future-proof; as fields get added to configurations, the 'id' sequence might change for the field you intended to use. Use hideFields(String) instead.
      Parameters:
      id - the sequence of the field you want to hide in the Field Configuration screen
    • showFields

      void showFields(String name)
      Parameters:
      name - The name of the field you wish to show e.g. Affects Version/s
    • hideFields

      void hideFields(String name)
      Parameters:
      name - The name of the field you wish to hide e.g. Component/s
    • requireField

      void requireField(String name)
      Parameters:
      name - The name of the field you wish to make required e.g. Description
    • optionalField

      void optionalField(String name)
      Parameters:
      name - The name of the field you wish to make optional e.g. Assignee
    • getRenderer

      String getRenderer(String fieldName)
      Parameters:
      fieldName - The name of the field e.g. Comment
      Returns:
      the name of the renderer in effect
      Throws:
      AssertionError - if the field is not renderable.
      Since:
      v4.2
    • setRenderer

      void setRenderer(String fieldName, String rendererName)
      Note: this assumes that the field is a Renderable Field.
      Parameters:
      fieldName - The nme of the field to apply the renderer to e.g. Log Work
      rendererName - The type of renderer to apply e.g. Wiki Style Renderer
      Since:
      v4.2
    • getScreens

      FieldScreenAssociations getScreens(String name)
      Parameters:
      name - The name of the field you wish to associate to screens e.g. Time Tracking
      Returns:
      an object to help you configure field screen associations
      Since:
      v4.2