com.atlassian.jira.web.util
Interface SubTaskQuickCreationConfig

All Known Implementing Classes:

SubTaskQuickCreationConfigImpl

public interface SubTaskQuickCreationConfig

Used to provide the SubTaskQuickCreationWebComponent with configuration parameters. For example, what fields should be displayed

Method Summary

java.util.Collection	getDisplayFieldIds() Returns a collection of field ids taht shodu be shown on the sub task quick creation form.
java.lang.String	getFieldI18nLabelKey(java.lang.String fieldId) Returns the i18n key for the given field id if such label for such field was defined, otherwise null.
java.util.Collection	getFieldIds() Same as getDisplayFieldIds(), only all the emty strings are stripped out of the returned collection.
java.lang.String	getPreset(java.lang.String fieldId) Returns the default field value
java.util.Collection	getPresetFieldIds() Returns a collection of field ids that have default values.
java.lang.String	getVelocityTemplate() Returns the path to the template.

Method Detail

getDisplayFieldIds

java.util.Collection getDisplayFieldIds()

Returns a collection of field ids taht shodu be shown on the sub task quick creation form. The collection uses empty strings to denote that an empty cell should be shown instead of a field. See IssueFieldConstants for possible field ids.

Returns:

collection of display field ids as String objects

getFieldIds

java.util.Collection getFieldIds()

Same as getDisplayFieldIds(), only all the emty strings are stripped out of the returned collection. This method is used by validation code.

Returns:

collection of field ids as String objects

getPresetFieldIds

java.util.Collection getPresetFieldIds()

Returns a collection of field ids that have default values.

Returns:

a collection of field ids that have default values.

getPreset

java.lang.String getPreset(java.lang.String fieldId)

Returns the default field value

Parameters:

fieldId - field id

Returns:

the default field value

getVelocityTemplate

java.lang.String getVelocityTemplate()

Returns the path to the template. The value comes from application properties.

Returns:

the path to the template

See Also:

APKeys.JIRA_SUBTASK_QUICKCREATE_TEMPLATE

getFieldI18nLabelKey

java.lang.String getFieldI18nLabelKey(java.lang.String fieldId)

Returns the i18n key for the given field id if such label for such field was defined, otherwise null.

Parameters:

fieldId - field id

Returns:

the i18n key or null

Since:

v3.11