Summary: Methods | [Expand All]
@PublicApi public interface

FieldConfigurationScheme

com.atlassian.jira.issue.fields.layout.field.FieldConfigurationScheme
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 Configuration Scheme maps each Issue Type to a "Field Configuration" (FieldLayoutSchemeEntity).

A Field Configuration defines for each field if it is required or not, whether it is visible or hidden, and what "Screens" it will appear on. (The Screen defines the order the fields are shown in, and can define multiple tabs).

See Also

Summary

Public Methods
Set<Long> getAllFieldLayoutIds(Collection<String> allIssueTypeIds)
Returns the id's of the field layout's represented by FieldConfigurationScheme (i.e.
String getDescription()
Long getFieldLayoutId(String issueTypeId)
Returns the id of the field layout to use for this given issue type id.
Long getId()
String getName()

Public Methods

public Set<Long> getAllFieldLayoutIds (Collection<String> allIssueTypeIds)

Returns the id's of the field layout's represented by FieldConfigurationScheme (i.e. the layouts associated with this project).

Parameters
allIssueTypeIds all the issue type id's that are in the system. This is used to determine if we need to return the layout for the default, if we have all the issue types mapped in the system then we do not care about the default since it is never used.
Returns
  • the id's of the FieldLayout ("Field Configuration") to use for the project this is associcated with.

public String getDescription ()

public Long getFieldLayoutId (String issueTypeId)

Returns the id of the field layout to use for this given issue type id. This will do all the necessary work to lookup the default entry if no specific mapping for the given isuse type id exists. So after calling this method simply use the returned field layout id.

Parameters
issueTypeId the Issue Type ID.
Returns
  • the id of the FieldLayout ("Field Configuration") to use for this given issue type id.

public Long getId ()

public String getName ()