java.lang.Object | |||
↳ | com.atlassian.jira.issue.customfields.impl.AbstractCustomFieldType<T, S> | ||
↳ | com.atlassian.jira.issue.customfields.impl.AbstractMultiCFType<S> | ||
↳ | com.atlassian.jira.issue.customfields.impl.MultiSelectCFType |
Multiple Select Type allows selecting of multiple Option
s
Option
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
MultiSelectCFType.InputTextProvider | Support interface to delay the data input text evaluation to vm-processing time. | ||||||||||
MultiSelectCFType.Visitor<T> |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | COMMA_REPLACEMENT |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parses the given comma-separated String value into a Collection.
| |||||||||||
Returns a String of representing values to be stored in the change log, an example is the name of a version
field that a version id will resolve to within JIRA.
| |||||||||||
Returns a List of
FieldConfigItemType objects. | |||||||||||
Returns lower level Information about the field.
| |||||||||||
Returns a Set of issue ids (
Long ) that have the given option selected. | |||||||||||
Return The default data for this system field.
| |||||||||||
Return a JsonData representation of the field value
| |||||||||||
Return a description of the shape of this field when represented as JSON.
| |||||||||||
Returns all possible Options for this field.
| |||||||||||
Returns the object that will perform the actual project import functions for the custom field type.
| |||||||||||
This method should be implemented in your custom type to return a Query.
| |||||||||||
Returns the RestFieldOperationsHandler for this field.
| |||||||||||
Returns a Singular Object, given the string value as passed by the presentation tier.
| |||||||||||
Takes a Collection of values and creates a comma-separated String that represents this Collection.
| |||||||||||
Return the String value object from the CustomFieldParams.
| |||||||||||
Retrieves the Transport Object representing the CustomField value instance from the CustomFieldParams of Strings.
| |||||||||||
The custom field may wish to pass parameters to the velocity context beyond the getValueFromIssue methods
(eg managers).
| |||||||||||
called when removing a field.
| |||||||||||
Perform any actions required if the option selected by the issue is removed.
| |||||||||||
Sets the default value for a Custom Field.
| |||||||||||
Ensures that the
CustomFieldParams of Strings is a valid representation of the Custom Field values. | |||||||||||
Used to compare 2 field values and work out whether a change item should be generated
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Converts a given db value to Single form of Transport Object
| |||||||||||
Converts a given underlying type to its db storage value.
| |||||||||||
Type of database field needed to store this field.
| |||||||||||
Returns a comparator for underlying type of this custom field.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Parses the given comma-separated String value into a Collection. Whitespace is trimmed and blank fields are
discarded. If literal commas are required, then they can be escaped with a backslash. Therefore the input String
"red, white\, and blue"
would produce two tokens in its list:
value | The comma-separated input String. |
---|
Returns a String of representing values to be stored in the change log, an example is the name of a version field that a version id will resolve to within JIRA.
field | CustomField that the value belongs to |
---|---|
value | Transport Object representing the value instance of the CustomField |
Returns a List of FieldConfigItemType
objects. Can not be immutable.
This opens up possibilities for configurable custom fields.
FieldConfigItemType
Returns lower level Information about the field. This information contains allowed values and/or the autocomplete url
fieldTypeInfoContext | context information for generating the FieldTypeInfo . |
---|
Returns a Set of issue ids (Long
) that have the given option selected.
field | the CustomField to search on |
---|---|
option | the Object representing a single value to search on. |
Return The default data for this system field. May be null if there is no default.
issueCtx | Issue (This should really only need to be an issue context, but for historical reasons we need an issue object. |
---|---|
field | the Custom Field |
Return a JsonData representation of the field value
field | configuration of the current field |
---|---|
issue | to get field data from |
renderedVersionRequested | whether the use requested the return of rendered/pretty data as well as raw data |
fieldLayoutItem | field layout for this field. |
Return a description of the shape of this field when represented as JSON.
Returns all possible Options for this field.
fieldConfig | configuration for this field |
---|---|
jiraContextNode | context |
Returns the object that will perform the actual project import functions for the custom field type.
This method should be implemented in your custom type to return a Query. Generally you should return a TermQuery
in the form of fieldName:groupName
. However some custom fields, such as (@Link SelectCFType)
manipulate the field identifiers and values before storing in the index. In cases like this you will have to
implement the method such that it searches the correct fields.
fieldID | the id of the custom field |
---|---|
groupName | the name of the group to filter on |
Returns the RestFieldOperationsHandler for this field.
field | the Custom Field |
---|
Returns a Singular Object, given the string value as passed by the presentation tier. Throws FieldValidationException if the string is an invalid representation of the Object.
string | the String |
---|
FieldValidationException |
---|
Takes a Collection of values and creates a comma-separated String that represents this Collection.
If any items in the collection include literal commas, then these commas are escaped with a prepended backslash. eg a list that looks like:
collection | a collection of Strings to be comma separated |
---|
Return the String value object from the CustomFieldParams. The object may be a single String (e.g. TextCFType, List of Strings (e.g. MultiSelectCFType) or CustomFieldParams of Strings (e.g. CascadingSelectCFType). Among other things these values are passed to Velocity for rendering edit screens.
parameters | - CustomFieldParams containing String values |
---|
Retrieves the Transport Object representing the CustomField value instance from the CustomFieldParams of Strings.
parameters | CustomFieldParams of String objects. Will contain one value for Singular field types. |
---|
createValue(CustomField, Issue, T)
, updateValue(CustomField, Issue, T)
FieldValidationException |
---|
The custom field may wish to pass parameters to the velocity context beyond the getValueFromIssue methods (eg managers).
The values are added to the context for all velocity views (edit, search, view, xml)
issue | The issue currently in context (Note: this will be null in cases like 'default value') |
---|---|
field | CustomField |
fieldLayoutItem | FieldLayoutItem |
Map
of parameters to add to the velocity context, or an empty Map otherwise (never null)
called when removing a field. return issue IDs affected.
Subclasses should override this if they have specific cleanup that they need to do (such as removing select list values)
Perform any actions required if the option selected by the issue is removed.
field | being edited |
---|---|
issue | to remove stuff from |
option | option being removed. |
Sets the default value for a Custom Field.
fieldConfig | CustomField for which the default is being stored |
---|---|
value | Transport Object representing the value instance of the CustomField. |
Ensures that the CustomFieldParams
of Strings is a valid representation of the Custom Field values.
Any errors should be added to the ErrorCollection
under the appropriate key as required.
relevantParams | parameter object of Strings |
---|---|
errorCollectionToAddTo | errorCollection to which any errors should be added (never null) |
config | FieldConfig |
Used to compare 2 field values and work out whether a change item should be generated
v1 | current value |
---|---|
v2 | new value |
Converts a given db value to Single form of Transport Object
dbValue | db representation as returned by convertTypeToDbValue(Object) |
---|
Converts a given underlying type to its db storage value. Must be compatable with PersistenceFieldType
returned by getDatabaseType()
value | Single form of Transport Object |
---|
Type of database field needed to store this field.
PersistenceFieldType
types.
Returns a comparator for underlying type of this custom field. Used e.g. for sorting values retrieved from the Database