Package com.atlassian.jira.issue.fields.config

Interface FieldConfigScheme

All Known Implementing Classes:
FieldConfigSchemeImpl, MockFieldConfigScheme
@PublicApi public interface FieldConfigScheme
A field config scheme is a set of FieldConfig objects that has been associated to a particular set of IssueTypes and then associated to a series of contexts (JiraContextNode). Methods return List will generally return nulls unless specified.

  • Method Details

    • getName

      String getName()

    • getDescription

      String getDescription()

    • getConfigs

      Map<String,FieldConfig> getConfigs()
      Returns a Map whose key is a String of issue types and the value is the FieldConfig for that issue type
      Returns:
      Map of FieldConfig keyed by name. Null if nothing associated

    • getId

      Long getId()

    • getContexts

      List<JiraContextNode> getContexts()
      Returns a list of JiraContextNode objects this scheme is relevant to
      Returns:
      list of JiraContextNode. an empty list if no contexts

    • isInContext

      boolean isInContext(IssueContext issueContext)

    • getAssociatedProjectObjects

      List<Project> getAssociatedProjectObjects()
      The associated projects, or an empty list if none associated.
      Returns:
      a not null list.
      See Also:

    • getAssociatedProjectIds

      @Nonnull List<Long> getAssociatedProjectIds()
      The associated projectIds, or an empty list if none associated. Note that any null project IDs are removed for compatibility with existing behaviour in getAssociatedProjectObjects().
      Returns:
      a not null list.
      See Also:

    • getAssociatedIssueTypes

      Collection<IssueType> getAssociatedIssueTypes()
      Returns the associated Issue Types.
      Returns:
      the associated Issue Types.

    • getAssociatedIssueTypeObjects

      @Deprecated default Collection<IssueType> getAssociatedIssueTypeObjects()
      Deprecated.
      Since v7.0
      Returns the associated Issue Types.
      Returns:
      the associated Issue Types.

    • getAssociatedIssueTypeIds

      @Nonnull Collection<String> getAssociatedIssueTypeIds()
      Returns the ids for the associated Issue Types.
      Returns:
      ids for the associated Issue Types.

    • isGlobal

      boolean isGlobal()

    • isAllProjects

      boolean isAllProjects()

    • isAllIssueTypes

      boolean isAllIssueTypes()

    • isEnabled

      boolean isEnabled()

    • isBasicMode

      boolean isBasicMode()

    • getConfigsByConfig

      org.apache.commons.collections.MultiMap getConfigsByConfig()
      Returns a Map whose key is a FieldConfig and values are associated a Collection Issue Type GenericValue
      Returns:
      MultiMap of configs.

    • getOneAndOnlyConfig

      @Nullable FieldConfig getOneAndOnlyConfig()
      Returns the one and only config for this scheme if there's only one config associated.
      Returns:
      The associated FieldConfig. Null if no configs, or more than one config

    • getField

      ConfigurableField<?> getField()