|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicApi 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
.
Method Summary | |
---|---|
ServiceOutcome<List<Long>> |
addToScreenTabs(com.atlassian.crowd.embedded.api.User user,
Long customFieldId,
List<Long> tabIds)
Adds a custom field with the given id to selected tabs. |
ServiceOutcome<CustomField> |
create(CreateValidationResult createValidationResult)
Creates a custom field using a CreateValidationResult as parameter. |
ServiceOutcome<List<Long>> |
removeFromScreenTabs(com.atlassian.crowd.embedded.api.User user,
Long customFieldId,
List<Long> tabIds)
Removes a custom field with the given id from selected tabs. |
void |
updateTranslation(JiraServiceContext jiraServiceContext,
Long customFieldId,
String name,
String description,
String locale)
Sets the current a translation for a custom field. |
ServiceOutcome<CreateValidationResult> |
validateCreate(com.atlassian.crowd.embedded.api.User user,
CustomFieldDefinition customFieldDefinition)
Validates that the custom field with the provided data can be created. |
void |
validateDelete(JiraServiceContext jiraServiceContext,
Long customFieldId)
Validates that the custom field with the provided id can be deleted. |
void |
validateTranslation(JiraServiceContext jiraServiceContext,
Long customFieldId,
String name,
String description,
String locale)
Validates that the parameters to set a translation for a custom field are valid |
void |
validateUpdate(JiraServiceContext jiraServiceContext,
Long customFieldId,
String name,
String description,
String searcherKey)
Validates that the custom field with the provided id can be updated. |
Method Detail |
---|
void validateDelete(JiraServiceContext jiraServiceContext, Long customFieldId)
jiraServiceContext
- containing the User
who is performing the change and
the ErrorCollection
that will contain any errors
in calling the methodcustomFieldId
- the custom field id of the custom field about to be deleted.void validateUpdate(JiraServiceContext jiraServiceContext, Long customFieldId, String name, String description, String searcherKey)
jiraServiceContext
- containing the User
who is performing the change and
the ErrorCollection
that will contain any errors
in calling the methodcustomFieldId
- the custom field id of the customfield about to be updatedname
- the updated name of the customfielddescription
- the description of the customfieldsearcherKey
- the customfield searcher that should be usedServiceOutcome<CreateValidationResult> validateCreate(com.atlassian.crowd.embedded.api.User user, CustomFieldDefinition customFieldDefinition)
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 validationcustomFieldDefinition
- - custom field data
ServiceOutcome<CustomField> create(CreateValidationResult createValidationResult) throws DataAccessException
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.
DataAccessException
- throwed when there is a problem with creating custom field in databaseServiceOutcome<List<Long>> addToScreenTabs(com.atlassian.crowd.embedded.api.User user, Long customFieldId, List<Long> tabIds)
user
- user who performs the changecustomFieldId
- id of custom fieldtabIds
- list of tab's id's to which we want to add custom field
ServiceOutcome<List<Long>> removeFromScreenTabs(com.atlassian.crowd.embedded.api.User user, Long customFieldId, List<Long> tabIds)
user
- user who performs the changecustomFieldId
- id of custom fieldtabIds
- list of tab's ids from which we want to remove custom field
void validateTranslation(JiraServiceContext jiraServiceContext, Long customFieldId, String name, String description, String locale)
jiraServiceContext
- containing the User
who is performing the change and
the ErrorCollection
that will contain any errors
in calling the methodcustomFieldId
- the custom field id of the customfield about to be updatedname
- the updated name of the customfielddescription
- the description of the customfieldlocale
- the locale of the translationvoid updateTranslation(JiraServiceContext jiraServiceContext, Long customFieldId, String name, String description, String locale)
jiraServiceContext
- containing the User
who is performing the change and
the ErrorCollection
that will contain any errors
in calling the methodcustomFieldId
- the custom field id of the customfield about to be updatedname
- the updated name of the customfielddescription
- the description of the customfieldlocale
- the locale of the translation
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |