java.lang.Object | |
↳ | com.atlassian.jira.bc.customfield.DefaultCustomFieldService |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds a custom field with the given id to selected tabs.
| |||||||||||
Creates a custom field using a
CreateValidationResult as parameter. | |||||||||||
Return the custom field if the passed user has permission to edit its configuration.
| |||||||||||
Return the
CustomFieldType s that the passed user can use to create a new CustomField . | |||||||||||
Return the default
CustomFieldSearcher for the passed CustomFieldType . | |||||||||||
Removes a custom field with the given id from selected tabs.
| |||||||||||
Sets the current a translation for a custom field.
| |||||||||||
Validates that the custom field with the provided data can be created.
| |||||||||||
Validates that the custom field with the provided id can be deleted.
| |||||||||||
Validates that the parameters to set a translation for a custom field are valid
| |||||||||||
Validates that the custom field with the provided id can be updated.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
com.atlassian.jira.bc.customfield.CustomFieldService
|
Adds a custom field with the given id to selected tabs. It returns list of ids of tabs on which custom field is present after performing "add" operation.
user | user who performs the change |
---|---|
customFieldId | id of custom field |
tabIds | list of tab's id's to which we want to add custom field |
Creates a custom field using a CreateValidationResult
as parameter.
CreateValidationResult is an output of createValidation method which should be executed before executing create.
createValidationResult | - data needed to create custom field, containing user. |
---|
Return the custom field if the passed user has permission to edit its configuration.
user | the user to check. |
---|---|
fieldId | the field to search for. |
Return the CustomFieldType
s that the passed user can use to create a new CustomField
.
A CustomFieldType
can be hidden if the passed user either does not have permission to see it or when
the type is locked and not meant to be created by users.
user | the user to check against. |
---|
CustomFieldType
s that the passed user can use to create a CustomField
.
Return the default CustomFieldSearcher
for the passed CustomFieldType
. The default searcher can
be null if there is no searcher associated with the type.
type | the CustomFieldType to query. |
---|
CustomFieldType
. Can be null if the type has no associated
searcher.
Removes a custom field with the given id from selected tabs. It returns list of ids of tabs on which custom field is present after performing "remove" operation.
user | user who performs the change |
---|---|
customFieldId | id of custom field |
tabIds | list of tab's ids from which we want to remove custom field |
Sets the current a translation for a custom field. The name and description can be empty and if so the translation will be cleared.
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 |
localeString | the locale of the translation |
Validates that the custom field with the provided data can be created. Data placeholder is the
CustomFieldDefinition
. The result of this operation is
CreateValidationResult
which after validation will contain all necessery data to create
a custom field (including user)
user | - the user who is performing the validation |
---|---|
customFieldDefinition | - custom field data |
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.
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. |
Validates that the parameters to set a translation for a custom field are valid
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 |
locale | the locale of the translation |
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.
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 |