com.atlassian.greenhopper.issue.fields

Interface CustomFieldUpdateService

All Known Implementing Classes:

CustomFieldUpdateServiceImpl

public interface CustomFieldUpdateService

Service to hide the way custom fields get updated. Should be used for custom field update operations. Implementation differs at runtime depending on the version of JIRA the plugin is running in

Method Summary

Modifier and Type	Method and Description
void	updateDescription(com.atlassian.jira.issue.fields.CustomField field, String newDescription) Update and save a new description for the given field
void	updateFieldSearcher(com.atlassian.jira.issue.fields.CustomField field, com.atlassian.jira.issue.customfields.CustomFieldSearcher searcher) Update and save the CustomFieldSearcher to be used by this field
void	updateName(com.atlassian.jira.issue.fields.CustomField field, String newName) Update and save a new name for the given field
void	updateNameAndDescription(com.atlassian.jira.issue.fields.CustomField field, String name, String description) Update both the name and description of the field.

Method Detail

updateName

void updateName(com.atlassian.jira.issue.fields.CustomField field,
                String newName)

Update and save a new name for the given field

Parameters:

field - to update

newName - the name to call the field

updateDescription

void updateDescription(com.atlassian.jira.issue.fields.CustomField field,
                       String newDescription)

Update and save a new description for the given field

Parameters:

field - to update

newDescription - the description to set on the field

updateNameAndDescription

void updateNameAndDescription(com.atlassian.jira.issue.fields.CustomField field,
                              String name,
                              String description)

Update both the name and description of the field. Similar to the above methods but only performs a single save operation.

Parameters:

field - to update

name - new name

description - new description

updateFieldSearcher

void updateFieldSearcher(com.atlassian.jira.issue.fields.CustomField field,
                         com.atlassian.jira.issue.customfields.CustomFieldSearcher searcher)

Update and save the CustomFieldSearcher to be used by this field

Parameters:

field - to update

searcher - to use