Interface FieldConfigurations.FieldConfiguration
- All Known Implementing Classes:
FieldConfigurationsImpl
- Enclosing interface:
- FieldConfigurations
public static interface FieldConfigurations.FieldConfiguration
Represents a field configuration that actions can be carried out on
-
Method Summary
Modifier and TypeMethodDescriptiongetRenderer
(String fieldName) getScreens
(String name) void
hideField
(int id) Deprecated.since 4.2.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) Deprecated.since 4.2.void
showFields
(String name)
-
Method Details
-
showField
void showField(int id) 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. UseshowFields(String)
instead.- Parameters:
id
- the sequence of the field you want to show in the Field Configuration screen
-
hideField
void hideField(int id) 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. UsehideFields(String)
instead.- Parameters:
id
- the sequence of the field you want to hide in the Field Configuration screen
-
showFields
- Parameters:
name
- The name of the field you wish to show e.g.Affects Version/s
-
hideFields
- Parameters:
name
- The name of the field you wish to hide e.g.Component/s
-
requireField
- Parameters:
name
- The name of the field you wish to make required e.g.Description
-
optionalField
- Parameters:
name
- The name of the field you wish to make optional e.g.Assignee
-
getRenderer
- 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.- Since:
- v4.2
-
setRenderer
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
- Since:
- v4.2
-
getScreens
- 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
- Since:
- v4.2
-