@PublicApi
public interface IssueService
Issue
's. This services
methods will make sure that when dealing with Issue
's that all of JIRA's business rules are enforced. This
means that permissions and data validation will be checked, proper events will be fired, and notifications will be
triggered.Modifier and Type | Interface and Description |
---|---|
static class |
IssueService.AssignValidationResult
A simple object that holds the information about validating an update issue operation.
|
static class |
IssueService.CreateValidationResult
A simple object that holds the information about validating a create issue operation.
|
static class |
IssueService.DeleteValidationResult
A simple object that holds the information about validating a delete issue operation.
|
static class |
IssueService.IssueResult
A simple object that holds the information about an issue operation.
|
static class |
IssueService.IssueValidationResult
A simple base object that holds the information about performing an issue operation.
|
static class |
IssueService.TransitionValidationResult
A simple result object that holds the information required to make a successful issue transition.
|
static class |
IssueService.UpdateValidationResult
A simple object that holds the information about validating an update issue operation.
|
Modifier and Type | Method and Description |
---|---|
IssueService.IssueResult |
assign(ApplicationUser user,
IssueService.AssignValidationResult assignResult)
This method will store the provided issue to the JIRA datastore and will transition it through workflow.
|
IssueService.IssueResult |
create(ApplicationUser user,
IssueService.CreateValidationResult createValidationResult)
This method will store the provided issue to the JIRA datastore.
|
IssueService.IssueResult |
create(ApplicationUser user,
IssueService.CreateValidationResult createValidationResult,
String initialWorkflowActionName)
This method will store the provided issue to the JIRA datastore.
|
ErrorCollection |
delete(ApplicationUser user,
IssueService.DeleteValidationResult deleteValidationResult)
This method will delete an issue from JIRA.
|
ErrorCollection |
delete(ApplicationUser user,
IssueService.DeleteValidationResult deleteValidationResult,
EventDispatchOption eventDispatchOption,
boolean sendMail)
This method will delete an issue from JIRA.
|
IssueService.IssueResult |
getIssue(ApplicationUser user,
Long issueId)
This method will retrieve the issue with the provided issue id if the current user has permission to view the
issue.
|
IssueService.IssueResult |
getIssue(ApplicationUser user,
String issueKey)
This method will retrieve the issue with the provided issue id if the current user has permission to view the
issue.
|
boolean |
isEditable(Issue issue,
ApplicationUser user)
Returns
true if the issue can be edited by the current user. |
IssueInputParameters |
newIssueInputParameters()
Constructs a new IssueInputParameters object with no initial values.
|
IssueInputParameters |
newIssueInputParameters(Map<String,String[]> actionParameters)
Constructs a new IssueInputParameters object with initial values provided by the input Map.
|
IssueService.IssueResult |
transition(ApplicationUser user,
IssueService.TransitionValidationResult transitionResult)
This method will store the provided issue to the JIRA datastore and will transition it through workflow.
|
IssueService.IssueResult |
update(ApplicationUser user,
IssueService.UpdateValidationResult updateValidationResult)
This method will store the provided issue to the JIRA datastore.
|
IssueService.IssueResult |
update(ApplicationUser user,
IssueService.UpdateValidationResult updateValidationResult,
EventDispatchOption eventDispatchOption,
boolean sendMail)
This method will store the provided issue to the JIRA datastore.
|
IssueService.AssignValidationResult |
validateAssign(ApplicationUser user,
Long issueId,
String assignee)
This method will check permissions to see if a user has the permission in relation to the provided issue, and
that the assignee is assignable.
|
IssueService.CreateValidationResult |
validateCreate(ApplicationUser user,
IssueInputParameters issueInputParameters)
This method will validate parameters and check permissions and if all checks pass it will create an
Issue
that can be passed to the #create(User, CreateValidationResult) method. |
IssueService.DeleteValidationResult |
validateDelete(ApplicationUser user,
Long issueId)
This method will check permissions to see if a user has the
Permissions.DELETE_ISSUE
permission in relation to the provided issue. |
IssueService.CreateValidationResult |
validateSubTaskCreate(ApplicationUser user,
Long parentId,
IssueInputParameters issueInputParameters)
This method does the same as
#validateCreate(User, IssueInputParameters) and it allows you to specify a
parentId such that the created issue will be a subtask of the provided parent id. |
IssueService.TransitionValidationResult |
validateTransition(ApplicationUser user,
Long issueId,
int actionId,
IssueInputParameters issueInputParameters)
This method will validate parameters and check the transition conditions and if all checks pass it will construct
a new instance of the
Issue and will update it with the new parameters. |
IssueService.TransitionValidationResult |
validateTransition(ApplicationUser user,
Long issueId,
int actionId,
IssueInputParameters issueInputParameters,
TransitionOptions transitionOptions)
This method will validate parameters and check the transition conditions and if all checks pass it will construct
a new instance of the
Issue and will update it with the new parameters. |
IssueService.UpdateValidationResult |
validateUpdate(ApplicationUser user,
Long issueId,
IssueInputParameters issueInputParameters)
This method will validate parameters and check permissions and if all checks pass it will construct a new
instance of the
Issue and will update it with the new parameters. |
IssueService.IssueResult getIssue(@Nullable ApplicationUser user, Long issueId)
user
- who the permission checks will be run against (can be null, indicating an anonymous user).issueId
- the database ID of the issue.Issue
for the provided id if the user has the Permissions.BROWSE
permission for the issue, the issue will be null if the issue
does not exist or the user does not have permission. The result also contains an error collection that will
contain any error messages that may have been generated when performing the operation.IssueService.IssueResult getIssue(@Nullable ApplicationUser user, String issueKey)
user
- who the permission checks will be run against (can be null, indicating an anonymous user).issueKey
- the key (e.g. TST-1) of the issue.Issue
for the provided id if the user has the Permissions.BROWSE
permission for the issue, the issue will be null if the issue
does not exist or the user does not have permission. The result also contains an error collection that will
contain any error messages that may have been generated when performing the operation.IssueService.CreateValidationResult validateSubTaskCreate(ApplicationUser user, Long parentId, IssueInputParameters issueInputParameters)
#validateCreate(User, IssueInputParameters)
and it allows you to specify a
parentId such that the created issue will be a subtask of the provided parent id.user
- who the permission checks will be run against (can be null, indicating an anonymous user).parentId
- the id of the parent Issue
for this subtask.issueInputParameters
- this represents the issue values we want to validate. It contains access to a raw map
of "web" style input parameters. These parameters are used to allow the fields to attain the user inputted
values. If you would like to specify some seed values for the field values holder that will be passed to the JIRA
fields, then you should set your map on this input values. Also, if you want to specify which fields have been
provided for user input, set the provided fields on this input, if not set this method will use the system
defaults. Fields not in the provided fields collection will not be validated but they will have their defaults
set.MutableIssue
if all validation passes
and the user has permission to create such an issue in the provided project, otherwise the issue will be null.
The result also contains an error collection that will contain any error messages that may have been generated
when performing the operation. It also contains a populated FieldValuesHolder that can be used by the fields to
re-render the user inputted values.IssueService.CreateValidationResult validateCreate(ApplicationUser user, IssueInputParameters issueInputParameters)
Issue
that can be passed to the #create(User, CreateValidationResult)
method.
This method will validate that the provided parameters are valid for the fields that are specified by the configured create screen for the provided project/issue type, unless over-ridden with the provided fields collection in the IssueInputParameters. Any fields that are not included on the create screen or provided fields will be populated with their default values and have those values validated. If any validation fails then this method will return a null Issue. Whether the methods validation is a success or a failure the fieldValuesHolder in the result will be populated with the data that is needed for the fields to render the inputted raw parameters.
user
- who the permission checks will be run against (can be null, indicating an anonymous user).issueInputParameters
- this represents the issue values we want to validate. It contains access to a raw map
of "web" style input parameters. These parameters are used to allow the fields to attain the user inputted
values. If you would like to specify some seed values for the field values holder that will be passed to the JIRA
fields, then you should set your map on this input values. Also, if you want to specify which fields have been
provided for user input, set the provided fields on this input, if not set this method will use the system
defaults. Fields not in the provided fields collection will not be validated but they will have their defaults
set.MutableIssue
if all validation passes
and the user has permission to create such an issue in the provided project, otherwise the issue will be null.
The result also contains an error collection that will contain any error messages that may have been generated
when performing the operation. It also contains a populated FieldValuesHolder that can be used by the fields to
re-render the user inputted values.IssueService.IssueResult create(ApplicationUser user, IssueService.CreateValidationResult createValidationResult)
This method will fire the EventType.ISSUE_CREATED_ID
event, thus triggering
any notifications that may need to be sent.
user
- who the permission checks will be run against (can be null, indicating an anonymous user).createValidationResult
- contains the issue to store. This should have been created by one of the
validateCreate methods. The result must have ServiceResult.isValid()
return true.
If false this method will throw an IllegalStateException.Issue
if all went. If there was an error creating
the issue then the issue will be null and the error collection will contain details of what went wrong.IssueService.IssueResult create(ApplicationUser user, IssueService.CreateValidationResult createValidationResult, String initialWorkflowActionName)
This method should only be used if you have a very complicated custom workflow where you have defined more than one initial action. In this case the auxilarySubmitButtonValue will indicate to the workflow manager which initial action should be executed.
This method will fire the EventType.ISSUE_CREATED_ID
event, thus triggering
any notifications that may need to be sent.
user
- who the permission checks will be run against (can be null, indicating an anonymous user).createValidationResult
- contains the issue to store. This should have been created by one of the
validateCreate methods. The result must have ServiceResult.isValid()
return true.
If false this method will throw an IllegalStateException.initialWorkflowActionName
- indicates which initial action to execute.Issue
if all went. If there was an error creating
the issue then the issue will be null and the error collection will contain details of what went wrong.IssueService.IssueResult update(ApplicationUser user, IssueService.UpdateValidationResult updateValidationResult)
This method will fire the EventType.ISSUE_UPDATED_ID
event, thus triggering
any notifications that may need to be sent.
user
- who the permission checks will be run against (can be null, indicating an anonymous user).updateValidationResult
- that contains the issue to update, this should have been created via the #validateUpdate(User, Long, IssueInputParameters)
method. The result must have ServiceResult.isValid()
return true. If false this method will throw an
IllegalStateException.Issue
if all went. If there was an error updating
the issue then the issue will be null and the error collection will contain details of what went wrong.IssueService.UpdateValidationResult validateUpdate(ApplicationUser user, Long issueId, IssueInputParameters issueInputParameters)
Issue
and will update it with the new parameters. This object can then be passed to the
#update(User, UpdateValidationResult)
method.
This method will validate that the provided parameters are valid for the fields that are specified by the configured edit screen for the issues project/issue type. Any fields that are not included on the edit screen will not be validated or populated.
If any validation fails then this method will return a null Issue. Whether the methods validation is a success or a failure the fieldValuesHolder will be populated with the data that is needed for the fields to render the inputted raw parameters.
The issue must also be in a open workflow state for this call to succeed.
user
- who the permission checks will be run against (can be null, indicating an anonymous user).issueId
- the unique identifer for the issue to update, this must be an issue that exists in JIRA with a
valid project/issue type.issueInputParameters
- this represents the issue values we want to validate. It contains access to a raw map
of "web" style input parameters. These parameters are used to allow the fields to attain the user inputted
values. If you would like to specify some seed values for the field values holder that will be passed to the JIRA
fields, then you should set your map on this input values. Also, if you want to specify which fields have been
provided for user input, set the provided fields on this input, if not set this method will use the system
defaults. Fields not in the provided fields collection will not be validated but they will have their defaults
set.#update(User, UpdateValidationResult)
method which contains an
MutableIssue
populated with the updated values and the error collection that
contains any validation errors that may have occurred. It also contains a populated FieldValuesHolder that can be
used by the fields to re-render the user inputted values.IssueService.IssueResult update(ApplicationUser user, IssueService.UpdateValidationResult updateValidationResult, EventDispatchOption eventDispatchOption, boolean sendMail)
This method should be used if you want to exert more control over what happens when JIRA updates an issue. This
method will allow you to specify if an event is dispatched and if so which event is dispatched, see EventDispatchOption
. This method also allows you to specify if email notifications
should be send to notify users of the update.
user
- who the permission checks will be run against (can be null, indicating an anonymous user).updateValidationResult
- contains the issue to update, this should have been created via the #validateUpdate(User, Long, com.atlassian.jira.issue.IssueInputParameters)
method. The result must have ServiceResult.isValid()
return true. If false this method will throw an
IllegalStateException.eventDispatchOption
- specifies if an event should be sent and if so which should be sent.sendMail
- if true mail notifications will be sent, otherwise mail notifications will be suppressed.Issue
if all went. If there was an error updating
the issue then the issue will be null and the error collection will contain details of what went wrong.IssueService.DeleteValidationResult validateDelete(ApplicationUser user, Long issueId)
Permissions.DELETE_ISSUE
permission in relation to the provided issue. If the current user does not have permission then an error will be
added to the service contexts error collection.user
- who the permission checks will be run against (can be null, indicating an anonymous user).issueId
- the unique identifier of the issue to delete#delete(User, com.atlassian.jira.bc.issue.IssueService.DeleteValidationResult)
method which contains an MutableIssue
and the error collection that contains any
validation errors that may have occurred.ErrorCollection delete(ApplicationUser user, IssueService.DeleteValidationResult deleteValidationResult)
Permissions.DELETE_ISSUE
permission. This will clean up all issue associations in
JIRA and will de-index the issue.
This method will dispatch the EventType.ISSUE_DELETED_ID
event and will
generate email notifications.
user
- who the permission checks will be run against (can be null, indicating an anonymous user).deleteValidationResult
- contains the issue to delete, this should have been created via the #validateDelete(User, Long)
method. The result must have ServiceResult.isValid()
return true. If false this method will throw an IllegalStateException.ErrorCollection delete(ApplicationUser user, IssueService.DeleteValidationResult deleteValidationResult, EventDispatchOption eventDispatchOption, boolean sendMail)
Permissions.DELETE_ISSUE
permission. This will clean up all issue associations in
JIRA and will de-index the issue.
This method should be used if you want to exert more control over what happens when JIRA deletes an issue. This
method will allow you to specify if an event is dispatched and if so which event is dispatched, see EventDispatchOption
. This method also allows you to specify if email notifications
should be send to notify users of the deletion.
user
- who the permission checks will be run against (can be null, indicating an anonymous user).deleteValidationResult
- contains the issue to delete, this should have been created via the #validateDelete(User, Long)
method. The result must have ServiceResult.isValid()
return true. If false this method will throw an IllegalStateException.eventDispatchOption
- specifies if an event should be sent and if so which should be sent.sendMail
- if true mail notifications will be sent, otherwise mail notifications will be suppressed.boolean isEditable(Issue issue, ApplicationUser user)
true
if the issue can be edited by the current user. This is determined by looking at both
the user's permissions and the workflow step the issue is in.issue
- the issue you want to edituser
- the user who will be performing the edittrue
if the user has permission and the issue is in an editable workflow stepIssueService.TransitionValidationResult validateTransition(ApplicationUser user, Long issueId, int actionId, IssueInputParameters issueInputParameters)
Issue
and will update it with the new parameters. This object can then be passed to
the #transition(User, TransitionValidationResult)
method.
This method will validate that the provided parameters are valid for the fields that are specified by the configured workflow transition screen for the issues project/issue type. Any fields that are not included on the screen will not be validated or populated. If the transition has no view then the issue fields will not be validated.
If any validation fails then this method will return a null TransitionResult. Whether the methods validation is a success or a failure the fieldValuesHolder will be populated with the data that is needed for the fields to render the inputted raw parameters.
This will call validateTransition below with TransitionOptions.defaults()
.
user
- who the permission checks will be run against (can be null, indicating an anonymous user).issueId
- the unique identifier for the issue to update, this must be an issue that exists in JIRA with a
valid project/issue type.actionId
- is the id of the workflow action that you would like to transition the issue through.issueInputParameters
- this represents the issue values we want to validate. It contains access to a raw map
of "web" style input parameters. These parameters are used to allow the fields to attain the user inputted
values. If you would like to specify some seed values for the field values holder that will be passed to the JIRA
fields, then you should set your map on this input values. Also, if you want to specify which fields have been
provided for user input, set the provided fields on this input, if not set this method will use the system
defaults. Fields not in the provided fields collection will not be validated but they will have their defaults
set.MutableIssue
populated with the
updated values and some additional parameters that are used when transitioning the issue through workflow and the
error collection that contains any validation errors that may have occurred. It also contains a populated
FieldValuesHolder that can be used by the fields to re-render the user inputted values.IssueService.TransitionValidationResult validateTransition(ApplicationUser user, Long issueId, int actionId, IssueInputParameters issueInputParameters, TransitionOptions transitionOptions)
Issue
and will update it with the new parameters. This object can then be passed to
the #transition(User, TransitionValidationResult)
method.
This method will validate that the provided parameters are valid for the fields that are specified by the configured workflow transition screen for the issues project/issue type. Any fields that are not included on the screen will not be validated or populated. If the transition has no view then the issue fields will not be validated.
If any validation fails then this method will return a null TransitionResult. Whether the methods validation is a success or a failure the fieldValuesHolder will be populated with the data that is needed for the fields to render the inputted raw parameters.
user
- who the permission checks will be run against (can be null, indicating an anonymous user).issueId
- the unique identifier for the issue to update, this must be an issue that exists in JIRA with a
valid project/issue type.actionId
- is the id of the workflow action that you would like to transition the issue through.issueInputParameters
- this represents the issue values we want to validate. It contains access to a raw map
of "web" style input parameters. These parameters are used to allow the fields to attain the user inputted
values. If you would like to specify some seed values for the field values holder that will be passed to the JIRA
fields, then you should set your map on this input values. Also, if you want to specify which fields have been
provided for user input, set the provided fields on this input, if not set this method will use the system
defaults. Fields not in the provided fields collection will not be validated but they will have their defaults
set.transitionOptions
- holds whether you wish to skip conditions or validators for this API call.MutableIssue
populated with the
updated values and some additional parameters that are used when transitioning the issue through workflow and the
error collection that contains any validation errors that may have occurred. It also contains a populated
FieldValuesHolder that can be used by the fields to re-render the user inputted values.IssueService.IssueResult transition(ApplicationUser user, IssueService.TransitionValidationResult transitionResult)
This method will fire the event associated with the workflow transition, thus triggering any notifications that may need to be sent.
user
- who the permission checks will be run against (can be null, indicating an anonymous user).transitionResult
- contains the issue to transition, with any updates that need to be persisted and the
action id which is the id of the workflow action that you would like to transition the issue through. The result
must have ServiceResult.isValid()
return true. If false this method will throw an
IllegalStateException.IssueService.AssignValidationResult validateAssign(ApplicationUser user, Long issueId, String assignee)
user
- who the permission checks will be run against (can be null, indicating an anonymous user).issueId
- the unique identifier for the issue to update, this must be an issue that exists in JIRA with a
valid project/issue type.assignee
- is the id of the user to assign the issue to.MutableIssue
populated with
the updated values and the error collection that contains any validation errors that may have occurred. It also
contains a populated FieldValuesHolder that can be used by the fields to re-render the user inputted values.IssueService.IssueResult assign(ApplicationUser user, IssueService.AssignValidationResult assignResult)
This method will fire the event associated with the workflow transition, thus triggering any notifications that may need to be sent.
user
- who the permission checks will be run against (can be null, indicating an anonymous user).assignResult
- contains the issue and assigneeId for the assignment. The result must have ServiceResult.isValid()
return true. If false this method will throw an
IllegalStateException.IssueInputParameters newIssueInputParameters()
IssueInputParameters is used as input to many of the methods in IssueService.
newIssueInputParameters(java.util.Map)
IssueInputParameters newIssueInputParameters(Map<String,String[]> actionParameters)
This is often used to pass HTTP Parameters with Issue values eg:
issueService.newIssueInputParameters(ActionContext.getParameters())
IssueInputParameters is used as input to many of the methods in IssueService.
actionParameters
- Parameters as received by a HTTP RequestnewIssueInputParameters()
Copyright © 2002-2015 Atlassian. All Rights Reserved.