@PublicApi public interface

FieldConfigScheme

com.atlassian.jira.issue.fields.config.FieldConfigScheme
Known Indirect Subclasses

@PublicApi

This interface 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

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.

Summary

Nested Classes
class FieldConfigScheme.Builder  
Public Methods
@Nonnull Collection<String> getAssociatedIssueTypeIds()
Returns the associated Issue Types.
Collection<IssueType> getAssociatedIssueTypeObjects()
Returns the associated Issue Types.
Set<GenericValue> getAssociatedIssueTypes()
This method is deprecated. Use getAssociatedIssueTypeObjects() instead. Since v6.1.
@Deprecated List<GenericValue> getAssociatedProjectCategories()
This method is deprecated. since 5.2 use getAssociatedProjectCategoryObjects() instead
List<ProjectCategory> getAssociatedProjectCategoryObjects()
@Nonnull List<Long> getAssociatedProjectIds()
The associated projectIds, or an empty list if none associated.
List<Project> getAssociatedProjectObjects()
The associated projects, or an empty list if none associated.
@Deprecated List<GenericValue> getAssociatedProjects()
This method is deprecated. since 5.1 use getAssociatedProjectObjects() instead
Map<StringFieldConfig> getConfigs()
Returns a Map whose key is a String of issue types and the value is the FieldConfig for that issue type
MultiMap getConfigsByConfig()
Returns a Map whose key is a FieldConfig and values are associated a Collection Issue Type GenericValue
List<JiraContextNode> getContexts()
Returns a list of JiraContextNode objects this scheme is relevent to
String getDescription()
ConfigurableField getField()
Long getId()
String getName()
FieldConfig getOneAndOnlyConfig()
Returns the one and only config for this scheme iff there's only one config associated
boolean isAllIssueTypes()
boolean isAllProjects()
boolean isBasicMode()
boolean isEnabled()
boolean isGlobal()
boolean isInContext(IssueContext issueContext)

Public Methods

@Nonnull public Collection<String> getAssociatedIssueTypeIds ()

Returns the associated Issue Types.

Returns
  • the associated Issue Types.

public Collection<IssueType> getAssociatedIssueTypeObjects ()

Returns the associated Issue Types.

Returns
  • the associated Issue Types.

public Set<GenericValue> getAssociatedIssueTypes ()

This method is deprecated.
Use getAssociatedIssueTypeObjects() instead. Since v6.1.

Returns the associated Issue Types.

Returns
  • the associated Issue Types.

@Deprecated public List<GenericValue> getAssociatedProjectCategories ()

This method is deprecated.
since 5.2 use getAssociatedProjectCategoryObjects() instead

public List<ProjectCategory> getAssociatedProjectCategoryObjects ()

@Nonnull public 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.

public List<Project> getAssociatedProjectObjects ()

The associated projects, or an empty list if none associated.

Returns
  • a not null list.

@Deprecated public List<GenericValue> getAssociatedProjects ()

This method is deprecated.
since 5.1 use getAssociatedProjectObjects() instead

The associated projects, or an empty list if none associated.

Returns
  • a not null list.

public Map<StringFieldConfig> 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

public MultiMap getConfigsByConfig ()

Returns a Map whose key is a FieldConfig and values are associated a Collection Issue Type GenericValue

Returns
  • MultiMap of configs.

public List<JiraContextNode> getContexts ()

Returns a list of JiraContextNode objects this scheme is relevent to

Returns

public String getDescription ()

public ConfigurableField getField ()

public Long getId ()

public String getName ()

public FieldConfig getOneAndOnlyConfig ()

Returns the one and only config for this scheme iff there's only one config associated

Returns
  • The associated FieldConfig. Null if no configs, or more than one config

public boolean isAllIssueTypes ()

public boolean isAllProjects ()

public boolean isBasicMode ()

public boolean isEnabled ()

public boolean isGlobal ()

public boolean isInContext (IssueContext issueContext)