com.atlassian.jira.issue.fields.layout.field

Interface FieldLayoutScheme

All Superinterfaces:

Named, NamedWithDescription, NamedWithId

All Known Implementing Classes:

FieldLayoutSchemeImpl

@PublicApi
public interface FieldLayoutScheme
extends NamedWithDescription, NamedWithId

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:

FieldConfigurationScheme

Field Summary

Fields inherited from interface com.atlassian.jira.util.Named

NAME_COMPARATOR

Method Summary

Modifier and Type	Method and Description
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.
org.ofbiz.core.entity.GenericValue	getGenericValue()
Long	getId()
String	getName()
Collection<org.ofbiz.core.entity.GenericValue>	getProjects() Deprecated. Use getProjectsUsing() instead. Since v6.4.
Collection<Project>	getProjectsUsing()
void	remove()
void	removeEntity(String issueTypeId)
void	setDescription(String description)
void	setGenericValue(org.ofbiz.core.entity.GenericValue genericValue)
void	setName(String name)
void	store()

Method Detail

getId

Long getId()

Specified by:

getId in interface NamedWithId

getName

String getName()

Specified by:

getName in interface Named

setName

void setName(String name)

getDescription

String getDescription()

Specified by:

getDescription in interface NamedWithDescription

setDescription

void setDescription(String description)

getGenericValue

org.ofbiz.core.entity.GenericValue getGenericValue()

setGenericValue

void setGenericValue(org.ofbiz.core.entity.GenericValue genericValue)

store

void store()

getFieldLayoutId

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.

addEntity

void addEntity(FieldLayoutSchemeEntity fieldLayoutSchemeEntity)

removeEntity

void removeEntity(String issueTypeId)

getEntities

Collection<FieldLayoutSchemeEntity> getEntities()

remove

void remove()

getEntity

FieldLayoutSchemeEntity getEntity(String issueTypeId)

getEntity

FieldLayoutSchemeEntity getEntity(EditableFieldLayout editableFieldLayout)

getProjects

Collection<org.ofbiz.core.entity.GenericValue> getProjects()

Deprecated. Use getProjectsUsing() instead. Since v6.4.

getProjectsUsing

Collection<Project> getProjectsUsing()

containsEntity

boolean containsEntity(String issueTypeId)