com.atlassian.jira.issue.fields.config
Interface FieldConfig
- All Known Implementing Classes:
- FieldConfigImpl
public interface FieldConfig
Represents a particular configuration of aConfigurableField
. A configuration can have many facets, such as default value
and options. These are customisable through registering FieldConfigItem
objects in the getConfigItems()
method.
This object is generally used in conjunction as part FieldConfigScheme
objects where a config can be attached
per IssueType
This is used in configuring custom fields..
Sample code
Retrieving a FieldConfig and using it to retrieve a set of custom field options:
IssueContextImpl
issueContext = new IssueContextImpl(projectGV, issueTypeGV)
;
FieldConfig
fieldConfig = cf.getRelevantConfig(issueContext)
;
Options
options = optionsManager.getOptions(fieldConfig)
;
- See Also:
FieldConfigScheme
,
FieldConfigItem
,
ConfigurableField
getId
Long getId()
setId
void setId(Long id)
getName
String getName()
setName
void setName(String name)
getDescription
String getDescription()
setDescription
void setDescription(String description)
getConfigItems
List getConfigItems()
- Returns:
- A list of
FieldConfigItem
s. Collections.EMPTY_LIST
if nothing
setConfigItems
void setConfigItems(List configItems)
- Parameters:
configItems
- A list of FieldConfigItem
s. Should never be null
getFieldId
String getFieldId()
setFieldId
void setFieldId(String fieldId)
getCustomField
CustomField getCustomField()
- Returns the related custom field. This is very much a legacy method as
FieldConfig
was originally only
used for customfields. Should eventually return a ConfigurableField
- Returns:
- Related
CustomField
- Throws:
DataAccessException
- if the fieldId does not refer to a valid custom field
Copyright © 2002-2007 Atlassian. All Rights Reserved.