com.atlassian.jira.plugin.customfield
Interface CustomFieldTypeModuleDescriptor
- All Superinterfaces:
- JiraResourcedModuleDescriptor<CustomFieldType>, com.atlassian.plugin.ModuleDescriptor<CustomFieldType>, com.atlassian.plugin.Resourced
- All Known Implementing Classes:
- CustomFieldTypeModuleDescriptorImpl
public interface CustomFieldTypeModuleDescriptor
- extends JiraResourcedModuleDescriptor<CustomFieldType>
Method Summary |
String |
getBulkMoveHtml(FieldConfig config,
Map customFieldValuesHolder,
Issue issue,
webwork.action.Action action,
Map displayParameters,
FieldLayoutItem fieldLayoutItem,
Map<Long,BulkMoveHelper.DistinctValueResult> distinctValues,
BulkMoveHelper bulkMoveHelper)
|
String |
getColumnViewHtml(CustomField field,
Object value,
Issue issue,
Map displayParams,
FieldLayoutItem fieldLayoutItem)
|
String |
getDefaultViewHtml(FieldConfig fieldConfig,
FieldLayoutItem fieldLayoutItem)
|
String |
getEditDefaultHtml(FieldConfig config,
Map customFieldValuesHolder,
Issue issue,
webwork.action.Action action,
Map displayParameters,
FieldLayoutItem fieldLayoutItem)
|
String |
getEditHtml(FieldConfig config,
Map customFieldValuesHolder,
Issue issue,
webwork.action.Action action,
Map displayParameters,
FieldLayoutItem fieldLayoutItem)
|
ConfigurationItemAccessLevel |
getManagedAccessLevel()
|
String |
getManagedDescriptionKey()
|
Set<String> |
getValidSearcherKeys()
Returns the list of Searchers that this CustomFieldType declares as usable to search itself. |
String |
getViewHtml(CustomField field,
Object value,
Issue issue,
FieldLayoutItem fieldLayoutItem)
|
String |
getViewHtml(CustomField field,
Object value,
Issue issue,
FieldLayoutItem fieldLayoutItem,
Map displayParameters)
|
String |
getViewXML(CustomField field,
Issue issue,
FieldLayoutItem fieldLayoutItem,
boolean raw)
|
boolean |
isColumnViewTemplateExists()
|
boolean |
isEditTemplateExists()
|
boolean |
isTypeManaged()
Is this custom field type a "managed" type? The provider of this type may want to control the circumstances in
which it is used. |
boolean |
isViewTemplateExists()
|
boolean |
isXMLTemplateExists()
|
Methods inherited from interface com.atlassian.plugin.ModuleDescriptor |
destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion |
Methods inherited from interface com.atlassian.plugin.Resourced |
getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation |
TEMPLATE_NAME_VIEW
static final String TEMPLATE_NAME_VIEW
- See Also:
- Constant Field Values
TEMPLATE_NAME_EDIT
static final String TEMPLATE_NAME_EDIT
- See Also:
- Constant Field Values
TEMPLATE_NAME_EDIT_DEFAULT
static final String TEMPLATE_NAME_EDIT_DEFAULT
- See Also:
- Constant Field Values
TEMPLATE_NAME_BULK_MOVE
static final String TEMPLATE_NAME_BULK_MOVE
- See Also:
- Constant Field Values
TEMPLATE_NAME_XML
static final String TEMPLATE_NAME_XML
- See Also:
- Constant Field Values
TEMPLATE_NAME_COLUMN
static final String TEMPLATE_NAME_COLUMN
- See Also:
- Constant Field Values
VELOCITY_VALUE_PARAM
static final String VELOCITY_VALUE_PARAM
- See Also:
- Constant Field Values
VELCITY_ACTION_PARAM
static final String VELCITY_ACTION_PARAM
- See Also:
- Constant Field Values
MANAGED_FLAG
static final String MANAGED_FLAG
- The name of the attribute to specify for a custom field type when you want new instances of this custom field type
to only be created by certain users. The values of this attribute are the string versions of
ConfigurationItemAccessLevel
.
- See Also:
- Constant Field Values
MANAGED_DESC
static final String MANAGED_DESC
- See Also:
- Constant Field Values
isViewTemplateExists
boolean isViewTemplateExists()
isColumnViewTemplateExists
boolean isColumnViewTemplateExists()
isEditTemplateExists
boolean isEditTemplateExists()
isXMLTemplateExists
boolean isXMLTemplateExists()
isTypeManaged
boolean isTypeManaged()
- Is this custom field type a "managed" type? The provider of this type may want to control the circumstances in
which it is used.
- Returns:
- boolean
getManagedAccessLevel
@Nullable
ConfigurationItemAccessLevel getManagedAccessLevel()
- Returns:
- the level which the user has to be to be able to create new instances of this custom field type; may return
null if level was not specified or was specified incorrectly
getManagedDescriptionKey
String getManagedDescriptionKey()
- Returns:
- the I18n key of the description explaining the reason this type is managed.
getEditHtml
String getEditHtml(FieldConfig config,
Map customFieldValuesHolder,
Issue issue,
webwork.action.Action action,
Map displayParameters,
FieldLayoutItem fieldLayoutItem)
getBulkMoveHtml
String getBulkMoveHtml(FieldConfig config,
Map customFieldValuesHolder,
Issue issue,
webwork.action.Action action,
Map displayParameters,
FieldLayoutItem fieldLayoutItem,
Map<Long,BulkMoveHelper.DistinctValueResult> distinctValues,
BulkMoveHelper bulkMoveHelper)
getEditDefaultHtml
String getEditDefaultHtml(FieldConfig config,
Map customFieldValuesHolder,
Issue issue,
webwork.action.Action action,
Map displayParameters,
FieldLayoutItem fieldLayoutItem)
getColumnViewHtml
String getColumnViewHtml(CustomField field,
Object value,
Issue issue,
Map displayParams,
FieldLayoutItem fieldLayoutItem)
getViewHtml
String getViewHtml(CustomField field,
Object value,
Issue issue,
FieldLayoutItem fieldLayoutItem)
getViewHtml
String getViewHtml(CustomField field,
Object value,
Issue issue,
FieldLayoutItem fieldLayoutItem,
Map displayParameters)
getViewXML
String getViewXML(CustomField field,
Issue issue,
FieldLayoutItem fieldLayoutItem,
boolean raw)
getDefaultViewHtml
String getDefaultViewHtml(FieldConfig fieldConfig,
FieldLayoutItem fieldLayoutItem)
getValidSearcherKeys
Set<String> getValidSearcherKeys()
- Returns the list of Searchers that this CustomFieldType declares as usable to search itself.
Note that it is also possible for a CustomFieldSearcher to declare a CustomFieldType that it is able to search on.
- Returns:
- the list of Searchers that this CustomFieldType declares as usable to search itself.
Copyright © 2002-2013 Atlassian. All Rights Reserved.