Summary: Methods | [Expand All]
public static interface

FieldConfigurations.FieldConfiguration

com.atlassian.jira.functest.framework.admin.FieldConfigurations.FieldConfiguration
Known Indirect Subclasses

Class Overview

Represents a field configuration that actions can be carried out on

Summary

Public Methods
String getRenderer(String fieldName)
FieldScreenAssociations getScreens(String name)
void hideField(int id)
This method is deprecated. since 4.2. This method is not future-proof; as fields get added to configurations, the 'id' sequence might change for the field you intended to use. Use hideFields(String) instead.
void hideFields(String name)
void optionalField(String name)
void requireField(String name)
void setRenderer(String fieldName, String rendererName)
Note: this assumes that the field is a Renderable Field.
void showField(int id)
This method is deprecated. since 4.2. This method is not future-proof; as fields get added to configurations, the 'id' sequence might change for the field you intended to use. Use showFields(String) instead.
void showFields(String name)

Public Methods

public String getRenderer (String fieldName)

Parameters
fieldName The name of the field e.g. Comment
Returns
  • the name of the renderer in effect
Throws
AssertionError if the field is not renderable.

public FieldScreenAssociations getScreens (String name)

Parameters
name The name of the field you wish to associate to screens e.g. Time Tracking
Returns
  • an object to help you configure field screen associations

public void hideField (int id)

This method is deprecated.
since 4.2. This method is not future-proof; as fields get added to configurations, the 'id' sequence might change for the field you intended to use. Use hideFields(String) instead.

Parameters
id the sequence of the field you want to hide in the Field Configuration screen

public void hideFields (String name)

Parameters
name The name of the field you wish to hide e.g. Component/s

public void optionalField (String name)

Parameters
name The name of the field you wish to make optional e.g. Assignee

public void requireField (String name)

Parameters
name The name of the field you wish to make required e.g. Description

public void setRenderer (String fieldName, String rendererName)

Note: this assumes that the field is a Renderable Field.

Parameters
fieldName The nme of the field to apply the renderer to e.g. Log Work
rendererName The type of renderer to apply e.g. Wiki Style Renderer

public void showField (int id)

This method is deprecated.
since 4.2. This method is not future-proof; as fields get added to configurations, the 'id' sequence might change for the field you intended to use. Use showFields(String) instead.

Parameters
id the sequence of the field you want to show in the Field Configuration screen

public void showFields (String name)

Parameters
name The name of the field you wish to show e.g. Affects Version/s