com.atlassian.configurable
Interface ValuesGenerator

All Known Implementing Classes:

ColumnNamesValuesGenerator, DateFieldValuesGenerator, FilterStatisticsCascadingSelectValuesGenerator, FilterStatisticsValuesGenerator, FilterValuesGenerator, ImapServersValuesGenerator, MailServersValuesGenerator, PopServersValuesGenerator, SearchRequestValuesGenerator, SortingValuesGenerator, SubTaskIncludeValuesGenerator, UserSubTaskIncludeValuesGenerator, VersionOptionalValuesGenerator, VersionValuesGenerator

public interface ValuesGenerator

Interface to implement when you want to retrieve a list of choices for a ConfiguraionProperty. The class you implement can be passed to a ValuesGeneratorObjectConfigurationProperty so it will use it to retrieve a list of choices.

Field Summary

static ValuesGenerator

NONE Implementation that returns no values at all.

Method Summary

Map	getValues(Map userParams) Map of choices to use

Field Detail

NONE

static final ValuesGenerator NONE

Implementation that returns no values at all.

Since:

28 Aug 2007 for JIRA v3.11

Method Detail

getValues

Map getValues(Map userParams)

Map of choices to use

Parameters:

userParams - Used to generate a relevant list of choices. e.g. may have some permissions in it

Returns:

Map which contains a list of choices as key value pairs. Can be null.