@PublicApi public class

CustomFieldDefinition

extends Object
java.lang.Object
   ↳ com.atlassian.jira.bc.customfield.CustomFieldDefinition

@PublicApi

This class is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

The CustomFIeldDefinition class is a builder that allows you to build the definition of custom field. This definition should be validated by 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 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

Summary

Nested Classes
class CustomFieldDefinition.Builder  
Public Constructors
@Deprecated CustomFieldDefinition()
This constructor is deprecated. Use a CustomFieldDefinition.Builder from builder() to create the definition. Since 6.1.
Public Methods
static CustomFieldDefinition.Builder builder()
String getCfType()
String getDescription()
List<String> getIssueTypeIds()
String getName()
List<Long> getProjectIds()
String getSearcherKey()
boolean isAllIssueTypes()
boolean isGlobal()
boolean isUseDefaultSearcher()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

@Deprecated public CustomFieldDefinition ()

This constructor is deprecated.
Use a CustomFieldDefinition.Builder from builder() to create the definition. Since 6.1.

This method is here is for API compatibility with 6.0 but is completely useless as this object is immutable.

Public Methods

public static CustomFieldDefinition.Builder builder ()

public String getCfType ()

public String getDescription ()

public List<String> getIssueTypeIds ()

public String getName ()

public List<Long> getProjectIds ()

public String getSearcherKey ()

public boolean isAllIssueTypes ()

public boolean isGlobal ()

public boolean isUseDefaultSearcher ()