Конфигурируемые параметры объектов

Плагины JIRA Report используют класс com.atlassian.configurable.ObjectConfigurable для упрощения процесса запроса (requesting) параметров конфигурации у пользователей. Эти параметры указаны в atlassian-plugin.xml как часть модуля отчета. Например, отчет о отслеживании времени, который поставляется с JIRA, имеет следующие входные параметры:


<properties>
    <property>
        <key>versionId</key>
        <name>common.concepts.version</name>
        <description>report.timetracking.version.description</description>
        <type>select</type>
        <values class="com.atlassian.jira.portal.VersionOptionalValuesGenerator"/>
    </property>
    <property>
        <key>sortingOrder</key>
        <name>report.timetracking.sortingorder</name>
        <description>report.timetracking.sortingorder.description</description>
        <type>select</type>
        <values class="com.atlassian.jira.portal.SortingValuesGenerator"/>
    </property>
    <property>
        <key>completedFilter</key>
        <name>report.timetracking.filter</name>
        <description>report.timetracking.filter.description</description>
        <type>select</type>
        <values class="com.atlassian.jira.portal.FilterValuesGenerator"/>
    </property>
</properties>

Типы

Типы определены в классе com.atlassian.configurable.ObjectConfigurationTypes. Доступные типы:

Тип

Тип ввода HTML

string

текстовое окно

long

текстовое окно

select

выбранное окно

multiselect

окно множественного  выбора

hidden

скрытое поле

date

текстовое окно с всплывающим календарем

user

текстовое окно с всплывающим подсказкой сортировщика пользователя

text

текстовая область

checkbox

флажок

cascadingselect

каскадные окна выбора

 

Значения

Значения могут предоставляться классом поставщика значений, который должен подклассифицировать com.atlassian.configurable.ValuesGenerator. Допустимые значения также могут быть жестко закодированы в дескрипторе модуля:


<values>
    <value>
        <key>KEY1</key>
        <value>somevalue</value>
    </value>
    <value>
        <key>KEY2</key>
        <value>someothervalue</value>
    </value>
</values>

Значения по умолчанию

Вы также можете указать значение по умолчанию для всех типов:


<default>5</default>
<values>  
        <value><key>1</key><value>1</value></value>
        <value><key>2</key><value>2</value></value>
        <value><key>3</key><value>3</value></value>
        <value><key>4</key><value>4</value></value>
        <value><key>5</key><value>5</value></value>
        ...
</values>

По материалам Atlassian JIRA Server Developer Object configurable parameters