@PublicApi public interface

FieldLayoutScheme

implements NamedWithDescription NamedWithId
com.atlassian.jira.issue.fields.layout.field.FieldLayoutScheme
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

FieldLayoutScheme is the Java Data Object representing what is called a "Field Configuration Scheme" in the UI.

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

[Expand]
Inherited Fields
From interface com.atlassian.jira.util.Named
Public Methods
void addEntity(FieldLayoutSchemeEntity fieldLayoutSchemeEntity)
boolean containsEntity(String issueTypeId)
String getDescription()
Collection<FieldLayoutSchemeEntity> getEntities()
FieldLayoutSchemeEntity getEntity(EditableFieldLayout editableFieldLayout)
FieldLayoutSchemeEntity getEntity(String issueTypeId)
Long getFieldLayoutId(String issueTypeId)
Returns the id of the field layout to use for this given issue type id.
GenericValue getGenericValue()
Long getId()
String getName()
Collection<GenericValue> getProjects()
This method is deprecated. Use getProjectsUsing() instead. Since v6.4.
Collection<Project> getProjectsUsing()
void remove()
void removeEntity(String issueTypeId)
void setDescription(String description)
void setGenericValue(GenericValue genericValue)
void setName(String name)
void store()
[Expand]
Inherited Methods
From interface com.atlassian.jira.util.Named
From interface com.atlassian.jira.util.NamedWithDescription
From interface com.atlassian.jira.util.NamedWithId

Public Methods

public void addEntity (FieldLayoutSchemeEntity fieldLayoutSchemeEntity)

public boolean containsEntity (String issueTypeId)

public String getDescription ()

public Collection<FieldLayoutSchemeEntity> getEntities ()

public FieldLayoutSchemeEntity getEntity (EditableFieldLayout editableFieldLayout)

public FieldLayoutSchemeEntity getEntity (String issueTypeId)

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 GenericValue getGenericValue ()

public Long getId ()

public String getName ()

public Collection<GenericValue> getProjects ()

This method is deprecated.
Use getProjectsUsing() instead. Since v6.4.

public Collection<Project> getProjectsUsing ()

public void remove ()

public void removeEntity (String issueTypeId)

public void setDescription (String description)

public void setGenericValue (GenericValue genericValue)

public void setName (String name)

public void store ()