com.atlassian.jira.issue.customfields

Interface GroupSelectorField

All Known Implementing Classes:

MultiGroupCFType, MultiSelectCFType, SelectCFType

public interface GroupSelectorField

An interface that can be implemented by a custom field type. By implementing this interface a custom field type lets JIRA 'know' that it can potentially be used as a 'Group Selector'. JIRA then uses this field in places where a group selector can be shown. For example:

• The GroupCF Security type uses a custom field of type 'Group Selector' to grant permissions.
• The InGroupCFCondition uses a custom field of type 'Group Selector' to determine if a user is allowed to execute a workflow transition.

A Group Selector is any field that can return a group name or a group id (String) as its value.

If a CustomFieldType implements this interface it should return values as objects of one of the following types:

• Group
• Collection of Groups
• String
• Collection of Strings

For example, a Multi Select custom field is a Group Selector as the values it returns are a Collection of Strings. These strings must represent group names. It is up to JIRA Administrator to ensure that the when the Multi Select custom field's options are defined, that all of them map exactly to a group name.

Method Summary

Modifier and Type	Method and Description
List<String>	getIdentifiersForGroup(String groupName) This method should be implemented in your custom type to return a List of identifiers of your group.

Method Detail

getIdentifiersForGroup

List<String> getIdentifiersForGroup(String groupName)

This method should be implemented in your custom type to return a List of identifiers of your group. Usually the identifier is just the groupName. However, some custom fields, such as SelectCFType assign ids to their values and index the ids. In such a case, the custom field should return all the ids under which the groupName was indexed. These should match the values that were used in the implementation of FieldIndexer.addIndex(Document, Issue, CustomFieldPrefetchedData)

Parameters:

groupName - The name of the group

Returns:

The group identifier that will be used to search for this group in the index