com.atlassian.jira.bc.customfield
Interface CustomFieldService

All Known Implementing Classes:
DefaultCustomFieldService

public interface CustomFieldService

Service front for the custom field manager. Implementations of this interface are responsible for carrying out any validation and permission logic required to carry out a certain task. The actual work required to do a certain task should be delegated to the CustomFieldManager.

Since:
v3.13

Method Summary
 void validateDelete(JiraServiceContext jiraServiceContext, java.lang.Long customFieldId)
          Validates that the custom field with the provided id can be deleted.
 void validateUpdate(JiraServiceContext jiraServiceContext, java.lang.Long customFieldId, java.lang.String name, java.lang.String description, java.lang.String searcherKey)
          Validates that the custom field with the provided id can be updated.
 

Method Detail

validateDelete

void validateDelete(JiraServiceContext jiraServiceContext,
                    java.lang.Long customFieldId)
Validates that the custom field with the provided id can be deleted. This means we check whether or not the custom field is used in any permission or issue level security schemes. This method will also check that the custom field with the given id exists. The user performing this operation needs to have global admin permission.

Parameters:
jiraServiceContext - containing the User who is performing the change and the ErrorCollection that will contain any errors in calling the method
customFieldId - the custom field id of the custom field about to be deleted.

validateUpdate

void validateUpdate(JiraServiceContext jiraServiceContext,
                    java.lang.Long customFieldId,
                    java.lang.String name,
                    java.lang.String description,
                    java.lang.String searcherKey)
Validates that the custom field with the provided id can be updated. This means we check whether or not the custom field is used in any permission or issue level security schemes if the custom field's searcher is being set to null. This method will also check that the custom field with the given id exists and that all its attributes are valid. The user performing this operation needs to have global admin permission.

Parameters:
jiraServiceContext - containing the User who is performing the change and the ErrorCollection that will contain any errors in calling the method
customFieldId - the custom field id of the customfield about to be updated
name - the updated name of the customfield
description - the description of the customfield
searcherKey - the customfield searcher that should be used


Copyright © 2002-2010 Atlassian. All Rights Reserved.