java.lang.Object | |
↳ | com.atlassian.jira.bc.issue.worklog.DefaultWorklogService |
Default implementation of the WorklogService.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Deletes the specified
Worklog . | |||||||||||
Deletes the specified
Worklog . | |||||||||||
Deletes the specified
Worklog . | |||||||||||
Deletes the specified
Worklog . | |||||||||||
Used to get a worklog by its id.
| |||||||||||
Returns all child worklogs of a specified issue.
| |||||||||||
Returns a PagedList over all all child worklogs of a specified issue that the provided user has permission to see.
| |||||||||||
Returns all child worklogs of a specified issue that the provided user has permission to see.
| |||||||||||
Returns a list of ids of worklogs which were removed, since the time provided in .
| |||||||||||
Returns a set of worklogs for provided ids.
| |||||||||||
Returns a list of worklogs visible by the calling user, which were modified since time provided in .
| |||||||||||
Determines if the user has the
WORK_ISSUE permission,
that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state. | |||||||||||
Determine whether the current user has the permission to delete the supplied
worklog, timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.
| |||||||||||
Determine whether the current user has the permission to update the supplied
worklog, timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.
| |||||||||||
Will return true if the issue is in an editable workflow state.
| |||||||||||
Will return true if
JIRA_OPTION_TIMETRACKING is true, false
otherwise. | |||||||||||
Updates the provided
Worklog . | |||||||||||
Updates the provided
Worklog . | |||||||||||
Updates the provided
Worklog . | |||||||||||
Determines whether worklogs are enabled in JIRA and if the user has the required permissions
as determined by calling
hasPermissionToCreate(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.Issue, boolean)
to create a worklog for this issue. | |||||||||||
Determines whether worklogs are enabled in JIRA and if the user has the required permission
as determined by calling
hasPermissionToCreate(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.Issue, boolean)
to create a worklog for this issue. | |||||||||||
Determines whether worklogs are enabled in JIRA and if the user has the required permission
as determined by calling
hasPermissionToCreate(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.Issue, boolean)
to create a worklog for this issue. | |||||||||||
Determines whether worklogs are enabled in JIRA and if the user has the required permissions
as determined by calling
hasPermissionToDelete(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.worklog.Worklog)
to delete a worklog for this issue. | |||||||||||
Determines whether worklogs are enabled in JIRA and if the user has the required permissions
as determined by calling
hasPermissionToDelete(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.worklog.Worklog)
to delete a worklog for this issue. | |||||||||||
Determines whether worklogs are enabled in JIRA and if the user has the required permissions
as determined by calling
hasPermissionToDelete(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.worklog.Worklog)
to delete a worklog for this issue. | |||||||||||
Determines whether worklogs are enabled in JIRA and if the user has the required permissions
as determined by calling
hasPermissionToUpdate(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.worklog.Worklog)
to update a worklog for this issue. | |||||||||||
Determines whether worklogs are enabled in JIRA and if the user has the required permissions
as determined by calling
hasPermissionToUpdate(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.worklog.Worklog)
to update a worklog for this issue. |
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Checks if the given String is a valid amount of time to change an estimate by.
| |||||||||||
Checks if the given String is a valid amount of time to change an estimate by.
| |||||||||||
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
com.atlassian.jira.bc.issue.worklog.WorklogService
|
Persists a new Worklog
on the given Issue
. This method will
auto-adjust the issues remaining estimate based on the value of the time spent on the work.
jiraServiceContext | containing the User who wishes to create a worklog and
the ErrorCollection that will contain any errors in calling the method |
---|---|
worklogResult | the WorklogResult generated by the validate call |
dispatchEvent | whether or not you want to have an event dispatched on Worklog creation @return the created Worklog object, or null if no object created. |
Persists a new Worklog
on the given Issue
. This method will
make no adjustment to the issues remaining estimate.
jiraServiceContext | containing the User who wishes to create a worklog and
the ErrorCollection that will contain any errors in calling the method |
---|---|
worklogResult | the WorklogResult generated by the validate call |
dispatchEvent | whether or not you want to have an event dispatched on Worklog creation @return the created Worklog object, or null if no object created. |
Persists a new Worklog
on the given Issue
. This method will
adjust the issues remaining estimate by reducing by the adjustmentAmount which has been passed to this method.
Before calling this method, you must call validateCreateWithManuallyAdjustedEstimate() to ensure that the
creation is OK.
jiraServiceContext | containing the User who wishes to create a worklog and
the ErrorCollection that will contain any errors in calling the method |
---|---|
worklogResult | the Worklog and adjustmentAmount for the issue. |
dispatchEvent | whether or not you want to have an event dispatched on Worklog creation |
Persists a new Worklog
on the given Issue
. This method will
adjust the issues remaining estimate to be the new value which has been passed to this method, the old
remaining estimate value will be lost.
jiraServiceContext | containing the User who wishes to create a worklog and
the ErrorCollection that will contain any errors in calling the method |
---|---|
worklogResult | the Worklog and new estimate for the issue. |
dispatchEvent | whether or not you want to have an event dispatched on Worklog creation |
Deletes the specified Worklog
. This method will auto-adjust the issues
remaining estimate by adding the time spent on the deleted worklog.
jiraServiceContext | containing the User who wishes to update the supplied worklog and
the ErrorCollection that will contain any errors encountered
in calling the method |
---|---|
worklogResult | result of the call to validateDelete(com.atlassian.jira.bc.JiraServiceContext, Long)
which contains the Worklog to delete |
dispatchEvent | whether or not you want to have an event dispatched on Worklog delete |
Worklog
was successfully deleted, false otherwise
Deletes the specified Worklog
. This method will
make no adjustment to the issues remaining estimate.
jiraServiceContext | containing the User who wishes to update the supplied worklog and
the ErrorCollection that will contain any errors encountered
in calling the method |
---|---|
worklogResult | result of the call to validateDelete(com.atlassian.jira.bc.JiraServiceContext, Long)
which contains the Worklog to delete |
dispatchEvent | whether or not you want to have an event dispatched on Worklog delete |
Worklog
was successfully deleted, false otherwise
Deletes the specified Worklog
. This method will
adjust the issues remaining estimate to be the new value which has been passed to this method, the old
remaining estimate value will be lost.
jiraServiceContext | containing the User who wishes to update the supplied worklog and
the ErrorCollection that will contain any errors encountered
in calling the method |
---|---|
worklogResult | the Worklog and adjustmentAmount for the issue. |
dispatchEvent | whether or not you want to have an event dispatched on Worklog delete @return the deleted Worklog object, or null if no object has been deleted. |
Worklog
was successfully deleted, false otherwise
Deletes the specified Worklog
. This method will
adjust the issues remaining estimate to be the new value which has been passed to this method, the old
remaining estimate value will be lost.
jiraServiceContext | containing the User who wishes to update the supplied worklog and
the ErrorCollection that will contain any errors encountered
in calling the method |
---|---|
worklogNewEstimate | the Worklog and new estimate for the issue. |
dispatchEvent | whether or not you want to have an event dispatched on Worklog delete @return the deleted Worklog object, or null if no object has been deleted. |
Worklog
was successfully deleted, false otherwise
Used to get a worklog by its id.
jiraServiceContext | containing the User who wishes to create a worklog and
the ErrorCollection that will contain any errors in calling the method |
---|---|
id | uniquely identifies the worklog |
Returns all child worklogs of a specified issue.
jiraServiceContext | containing the User who wishes to create a worklog and
the ErrorCollection that will contain any errors in calling the method |
---|---|
issue | the specified parent issue (not null) |
Returns a PagedList over all all child worklogs of a specified issue that the provided user has permission to see.
jiraServiceContext | containing the User who wishes to create a worklog and
the ErrorCollection that will contain any errors in calling the method |
---|---|
issue | the specified parent issue (not null) |
pageSize | the number of worklogs per page |
Returns all child worklogs of a specified issue that the provided user has permission to see.
jiraServiceContext | containing the User who wishes to create a worklog and
the ErrorCollection that will contain any errors in calling the method |
---|---|
issue | the specified parent issue (not null) |
Returns a list of ids of worklogs which were removed, since the time provided in .
The list is limited to WORKLOG_UPDATE_DATA_PAGE_SIZE
elements, in order
to get more elements, execute this method again with which is equal to removal time of the last element
in the result.
This won't return worklogs updated within last minute.
user | user retrieving the list of deleted worklogs since a qiven time expressed in milliseconds. |
---|---|
sinceInMilliseconds | the time (measured as a difference between the timestamp and midnight, January 1, 1970 UTC) since which the deleted worklogs will be returned. |
Returns a set of worklogs for provided ids. If the calling user doesn't have permissions to get worklog for given
id, the worklog won't be returned.
The set is limited to WORKLOG_UPDATE_DATA_PAGE_SIZE
elements,
in order to get more elements, execute this method again providing ids of other Worklog
to retrieve.
jiraServiceContext | containing the User who wishes to create a worklog and
the ErrorCollection that will contain any errors in calling the method |
---|---|
idsOfWorklogs | set of ids for which worklogs will be returned. |
Returns a list of worklogs visible by the calling user, which were modified since time provided in .
The list is limited to WORKLOG_UPDATE_DATA_PAGE_SIZE
elements, in order
to get more elements, execute this method again with which is equal to the updated time of the last element
in the result.
This won't return worklogs updated within last minute.
user | user retrieving the list of modified worklogs since a qiven time expressed in miliseconds. |
---|---|
sinceInMilliseconds | the time (measured as a difference between the timestamp and midnight, January 1, 1970 UTC) since which the modified worklogs will be returned. |
Determines if the user has the WORK_ISSUE
permission,
that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.
jiraServiceContext | containing the User who wishes to create a worklog and
the ErrorCollection that will contain any errors in calling the method |
---|---|
issue | the issue to add the worklog to |
isEditableCheckRequired | set to true if we require the issue to be in an editable state. This should always be the case except when logging work on transition |
Determine whether the current user has the permission to delete the supplied worklog, timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.
In case of errors, add error messages to the error collection within the servicecontext.
Passing in null worklog or a worklog with null ID will return false and an error message will be added to the error collection.
Passing in null error collection will throw NPE.
This method will return true if the user is a member of the worklog's group/role level (if specified) AND
WORKLOG_DELETE_ALL
permission; ORWorklog
author and has the WORKLOG_DELETE_OWN
permissionjiraServiceContext | containing the User who wishes to delete the worklog and
the ErrorCollection that will contain any errors
in calling the method |
---|---|
worklog | the Worklog the user wishes to delete |
Determine whether the current user has the permission to update the supplied worklog, timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.
In case of errors, add error messages to the error collection within the servicecontext.
Passing in null worklog or a worklog with null ID will return false and an error message will be added to the error collection.
Passing in null error collection will throw NPE.
This method will return true if the user is a member of the worklog's group/role level (if specified) AND
WORKLOG_EDIT_ALL
permission; ORWorklog
author and has the WORKLOG_EDIT_OWN
permissionjiraServiceContext | containing the User who wishes to update the worklog and
the ErrorCollection that will contain any errors
in calling the method |
---|---|
worklog | the Worklog the user wishes to update |
Will return true if the issue is in an editable workflow state.
issue | the issue to see if it is in an editable store |
---|
Will return true if JIRA_OPTION_TIMETRACKING
is true, false
otherwise.
Updates the provided Worklog
. This method will auto-adjust the issues
remaining estimate based on the updated value of the time spent on the work.
jiraServiceContext | containing the User who wishes to update the worklog and
the ErrorCollection that will contain any errors
in calling the method |
---|---|
worklogResult | result of the call to validateUpdate(com.atlassian.jira.bc.JiraServiceContext, WorklogInputParameters)
which contains the Worklog to update |
dispatchEvent | whether or not you want to have an event dispatched on Worklog update |
Updates the provided Worklog
. This method will
make no adjustment to the issues remaining estimate.
jiraServiceContext | containing the User who wishes to update the supplied worklog and
the ErrorCollection that will contain any errors encountered
in calling the method |
---|---|
worklogResult | result of the call to validateUpdate(com.atlassian.jira.bc.JiraServiceContext, WorklogInputParameters)
which contains the Worklog to update |
dispatchEvent | whether or not you want to have an event dispatched on Worklog update |
Updates the provided Worklog
. This method will
adjust the issues remaining estimate to be the new value which has been passed to this method, the old
remaining estimate value will be lost.
jiraServiceContext | containing the User who wishes to create a worklog and
the ErrorCollection that will contain any errors in calling the method |
---|---|
worklogResult | the Worklog and new estimate for the issue. |
dispatchEvent | whether or not you want to have an event dispatched on Worklog update @return the updated Worklog object, or null if no object has been updated. |
Determines whether worklogs are enabled in JIRA and if the user has the required permissions
as determined by calling hasPermissionToCreate(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.Issue, boolean)
to create a worklog for this issue.
jiraServiceContext | containing the user who wishes to create a worklog and the errorCollection that will contain any errors in calling the method |
---|---|
params | parameter object that contains all the values required to validate |
Determines whether worklogs are enabled in JIRA and if the user has the required permission
as determined by calling hasPermissionToCreate(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.Issue, boolean)
to create a worklog for this issue.
jiraServiceContext | containing the user who wishes to create a worklog and the errorCollection that will contain any errors in calling the method |
---|---|
params | parameter object that contains all the values required to validate |
Determines whether worklogs are enabled in JIRA and if the user has the required permission
as determined by calling hasPermissionToCreate(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.Issue, boolean)
to create a worklog for this issue.
jiraServiceContext | containing the user who wishes to create a worklog and the errorCollection that will contain any errors in calling the method |
---|---|
params | parameter object that contains all the values required to validate |
Determines whether worklogs are enabled in JIRA and if the user has the required permissions
as determined by calling hasPermissionToDelete(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.worklog.Worklog)
to delete a worklog for this issue.
jiraServiceContext | containing the user who wishes to create a worklog and the errorCollection that will contain any errors in calling the method |
---|---|
worklogId | identifies the worklog that the update validation will occur against |
Determines whether worklogs are enabled in JIRA and if the user has the required permissions
as determined by calling hasPermissionToDelete(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.worklog.Worklog)
to delete a worklog for this issue.
jiraServiceContext | containing the user who wishes to create a worklog and the errorCollection that will contain any errors in calling the method |
---|---|
worklogId | identifies the worklog that the delete validation will occur against |
adjustmentAmount | The value to increase the issues remaining estimate by. |
Determines whether worklogs are enabled in JIRA and if the user has the required permissions
as determined by calling hasPermissionToDelete(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.worklog.Worklog)
to delete a worklog for this issue.
jiraServiceContext | containing the user who wishes to create a worklog and the errorCollection that will contain any errors in calling the method |
---|---|
worklogId | identifies the worklog that the delete validation will occur against |
newEstimate | The value to change the issues remaining estimate to. |
Determines whether worklogs are enabled in JIRA and if the user has the required permissions
as determined by calling hasPermissionToUpdate(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.worklog.Worklog)
to update a worklog for this issue.
jiraServiceContext | containing the user who wishes to create a worklog and the errorCollection that will contain any errors in calling the method |
---|---|
params | parameter object that contains all the values required to validate |
Determines whether worklogs are enabled in JIRA and if the user has the required permissions
as determined by calling hasPermissionToUpdate(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.worklog.Worklog)
to update a worklog for this issue.
jiraServiceContext | containing the user who wishes to create a worklog and the errorCollection that will contain any errors in calling the method |
---|---|
params | parameter object that contains all the values required to validate |
Checks if the given String is a valid amount of time to change an estimate by.
jiraServiceContext | JiraServiceContext |
---|---|
adjustmentAmount | String with amount of time eg "3d 4h" |
errorFieldPrefix | the prefix for the error field |
Checks if the given String is a valid amount of time to change an estimate by.
jiraServiceContext | JiraServiceContext |
---|---|
adjustmentAmount | String with amount of time eg "3d 4h" |