Package com.atlassian.jira.bc.customfield

Class CustomFieldDefinition

java.lang.Object
com.atlassian.jira.bc.customfield.CustomFieldDefinition
@PublicApi public class CustomFieldDefinition extends Object
The CustomFIeldDefinition class is a builder that allows you to build the definition of custom field. This definition should be validated by
invalid reference 
CustomFieldService#validateCreate(com.atlassian.crowd.embedded.api.User, CustomFieldDefinition)
The outcome of validation is CreateValidationResult which is a validated definition of custom field which can now be created using
invalid reference 
CustomFieldService#validateCreate(com.atlassian.crowd.embedded.api.User, CustomFieldDefinition)

Builder params: name name of the custom field description - description of the custom field cfType - key of the custom field type searcherKey - key to identify a searcher for the custom field projectIds - list of project id's in which custom field should be available issueTypeIds - list of issue types id's in which custom field should be available isGlobal - flag which overrides project id's. If set to true custom field is created in global context allIssueTypes - flag which overrides issue types id's. If set to true custom filed will be available for all issue types

Since:
v6.0

  • Method Details

    • getCfType

      public String getCfType()

    • getName

      public String getName()

    • getDescription

      public String getDescription()

    • getSearcherKey

      public String getSearcherKey()

    • isUseDefaultSearcher

      public boolean isUseDefaultSearcher()

    • getProjectIds

      public List<Long> getProjectIds()

    • getIssueTypeIds

      public List<String> getIssueTypeIds()

    • isGlobal

      public boolean isGlobal()

    • isAllIssueTypes

      public boolean isAllIssueTypes()

    • builder

      public static CustomFieldDefinition.Builder builder()