|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorklogService
This is the business layer component that must be used to access all WorklogService
functionality.
This will perform validation before it hands off to the WorklogManager
.
Operations will not be performed if validation fails.
Nested Class Summary | |
---|---|
static class |
WorklogService.WorklogAdjustmentAmountResult
Aggregate of a Worklog and an adjustment amount in seconds. |
static class |
WorklogService.WorklogNewEstimateResult
Aggregate of a Worklog and an estimate in seconds. |
Method Summary | |
---|---|
Worklog |
createAndAutoAdjustRemainingEstimate(JiraServiceContext jiraServiceContext,
Worklog worklog,
boolean dispatchEvent)
Persists a new Worklog on the given Issue . |
Worklog |
createAndRetainRemainingEstimate(JiraServiceContext jiraServiceContext,
Worklog worklog,
boolean dispatchEvent)
Persists a new Worklog on the given Issue . |
Worklog |
createWithManuallyAdjustedEstimate(JiraServiceContext jiraServiceContext,
WorklogService.WorklogAdjustmentAmountResult worklogAdjustmentAmount,
boolean dispatchEvent)
Persists a new Worklog on the given Issue . |
Worklog |
createWithNewRemainingEstimate(JiraServiceContext jiraServiceContext,
WorklogService.WorklogNewEstimateResult worklogNewEstimate,
boolean dispatchEvent)
Persists a new Worklog on the given Issue . |
boolean |
deleteAndAutoAdjustRemainingEstimate(JiraServiceContext jiraServiceContext,
Worklog worklog,
boolean dispatchEvent)
Deletes the specified Worklog . |
boolean |
deleteAndRetainRemainingEstimate(JiraServiceContext jiraServiceContext,
Worklog worklog,
boolean dispatchEvent)
Deletes the specified Worklog . |
boolean |
deleteWithManuallyAdjustedEstimate(JiraServiceContext jiraServiceContext,
WorklogService.WorklogAdjustmentAmountResult worklogAdjustmentAmount,
boolean dispatchEvent)
Deletes the specified Worklog . |
boolean |
deleteWithNewRemainingEstimate(JiraServiceContext jiraServiceContext,
WorklogService.WorklogNewEstimateResult worklogNewEstimate,
boolean dispatchEvent)
Deletes the specified Worklog . |
Worklog |
getById(JiraServiceContext jiraServiceContext,
Long id)
Used to get a worklog by its id. |
List |
getByIssue(JiraServiceContext jiraServiceContext,
Issue issue)
Returns all child worklogs of a specified issue. |
List |
getByIssueVisibleToUser(JiraServiceContext jiraServiceContext,
Issue issue)
Returns all child worklogs of a specified issue that the provided user has permission to see. |
boolean |
hasPermissionToCreate(JiraServiceContext jiraServiceContext,
Issue issue)
Determines if the user has the Permissions.WORK_ISSUE permission,
that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state. |
boolean |
hasPermissionToDelete(JiraServiceContext jiraServiceContext,
Worklog worklog)
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. |
boolean |
hasPermissionToUpdate(JiraServiceContext jiraServiceContext,
Worklog worklog)
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. |
boolean |
isIssueInEditableWorkflowState(Issue issue)
Will return true if the issue is in an editable workflow state. |
boolean |
isTimeTrackingEnabled()
Will return true if APKeys.JIRA_OPTION_TIMETRACKING is true, false
otherwise. |
Worklog |
updateAndAutoAdjustRemainingEstimate(JiraServiceContext jiraServiceContext,
Worklog worklog,
boolean dispatchEvent)
Updates the provided Worklog . |
Worklog |
updateAndRetainRemainingEstimate(JiraServiceContext jiraServiceContext,
Worklog worklog,
boolean dispatchEvent)
Updates the provided Worklog . |
Worklog |
updateWithNewRemainingEstimate(JiraServiceContext jiraServiceContext,
WorklogService.WorklogNewEstimateResult worklogNewEstimate,
boolean dispatchEvent)
Updates the provided Worklog . |
Worklog |
validateCreate(JiraServiceContext jiraServiceContext,
Issue issue,
String timeSpent,
Date startDate,
String comment,
String groupLevel,
String roleLevelId)
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)
to create a worklog for this issue. |
WorklogService.WorklogAdjustmentAmountResult |
validateCreateWithManuallyAdjustedEstimate(JiraServiceContext jiraServiceContext,
Issue issue,
String timeSpent,
Date startDate,
String comment,
String groupLevel,
String roleLevelId,
String adjustmentAmount)
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)
to create a worklog for this issue. |
WorklogService.WorklogNewEstimateResult |
validateCreateWithNewEstimate(JiraServiceContext jiraServiceContext,
Issue issue,
String timeSpent,
Date startDate,
String comment,
String groupLevel,
String roleLevelId,
String newEstimate)
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)
to create a worklog for this issue. |
Worklog |
validateDelete(JiraServiceContext jiraServiceContext,
Long worklogId)
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. |
WorklogService.WorklogAdjustmentAmountResult |
validateDeleteWithManuallyAdjustedEstimate(JiraServiceContext jiraServiceContext,
Long worklogId,
String adjustmentAmount)
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. |
WorklogService.WorklogNewEstimateResult |
validateDeleteWithNewEstimate(JiraServiceContext jiraServiceContext,
Long worklogId,
String newEstimate)
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. |
Worklog |
validateUpdate(JiraServiceContext jiraServiceContext,
Long worklogId,
String timeSpent,
Date startDate,
String comment,
String groupLevel,
String roleLevelId)
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. |
WorklogService.WorklogNewEstimateResult |
validateUpdateWithNewEstimate(JiraServiceContext jiraServiceContext,
Long worklogId,
String timeSpent,
Date startDate,
String comment,
String groupLevel,
String roleLevelId,
String newEstimate)
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. |
Method Detail |
---|
Worklog validateDelete(JiraServiceContext jiraServiceContext, Long worklogId)
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 methodworklogId
- identifies the worklog that the update validation will occur against
WorklogService.WorklogNewEstimateResult validateDeleteWithNewEstimate(JiraServiceContext jiraServiceContext, Long worklogId, String newEstimate)
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 methodworklogId
- identifies the worklog that the delete validation will occur againstnewEstimate
- The value to change the issues remaining estimate to.
WorklogService.WorklogAdjustmentAmountResult validateDeleteWithManuallyAdjustedEstimate(JiraServiceContext jiraServiceContext, Long worklogId, String adjustmentAmount)
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 methodworklogId
- identifies the worklog that the delete validation will occur againstadjustmentAmount
- The value to increase the issues remaining estimate by.
boolean deleteWithNewRemainingEstimate(JiraServiceContext jiraServiceContext, WorklogService.WorklogNewEstimateResult worklogNewEstimate, boolean dispatchEvent)
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 methodworklogNewEstimate
- 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 otherwiseboolean deleteWithManuallyAdjustedEstimate(JiraServiceContext jiraServiceContext, WorklogService.WorklogAdjustmentAmountResult worklogAdjustmentAmount, boolean dispatchEvent)
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 methodworklogAdjustmentAmount
- 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 otherwiseboolean deleteAndRetainRemainingEstimate(JiraServiceContext jiraServiceContext, Worklog worklog, boolean dispatchEvent)
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 methodworklog
- Deletes a worklog from the datastore (identified by its id). This should have been generated by a call to
validateDelete(com.atlassian.jira.bc.JiraServiceContext,Long)
dispatchEvent
- whether or not you want to have an event dispatched on Worklog delete
Worklog
was successfully deleted, false otherwiseboolean deleteAndAutoAdjustRemainingEstimate(JiraServiceContext jiraServiceContext, Worklog worklog, boolean dispatchEvent)
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 methodworklog
- Deletes a worklog from the datastore (identified by its id). This should have been generated by a call to
validateDelete(com.atlassian.jira.bc.JiraServiceContext,Long)
dispatchEvent
- whether or not you want to have an event dispatched on Worklog delete
Worklog
was successfully deleted, false otherwiseWorklog validateUpdate(JiraServiceContext jiraServiceContext, Long worklogId, String timeSpent, Date startDate, String comment, String groupLevel, String roleLevelId)
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 methodworklogId
- identifies the worklog that the update validation will occur againsttimeSpent
- the time spent on the workstartDate
- the date on which the work was performedcomment
- The body of the comment associated with the workloggroupLevel
- The group level visibility of the worklog (null if roleLevelId specified)roleLevelId
- The role level id visibility of the worklog (null if groupLevel specified)
WorklogService.WorklogNewEstimateResult validateUpdateWithNewEstimate(JiraServiceContext jiraServiceContext, Long worklogId, String timeSpent, Date startDate, String comment, String groupLevel, String roleLevelId, String newEstimate)
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 methodworklogId
- identifies the worklog that the update validation will occur againsttimeSpent
- the time spent on the workstartDate
- the date on which the work was performedcomment
- The body of the comment associated with the workloggroupLevel
- The group level visibility of the worklog (null if roleLevelId specified)roleLevelId
- The role level id visibility of the worklog (null if groupLevel specified)newEstimate
- The value to change the issues remaining estimate to.
Worklog updateWithNewRemainingEstimate(JiraServiceContext jiraServiceContext, WorklogService.WorklogNewEstimateResult worklogNewEstimate, boolean dispatchEvent)
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 methodworklogNewEstimate
- 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.
Worklog updateAndRetainRemainingEstimate(JiraServiceContext jiraServiceContext, Worklog worklog, boolean dispatchEvent)
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 methodworklog
- Updates fields of an existing worklog in the datastore (identified by its id) with the
supplied worklog.This should have been generated by a call to
validateUpdate(com.atlassian.jira.bc.JiraServiceContext,Long,String,java.util.Date,String,String,String)
dispatchEvent
- whether or not you want to have an event dispatched on Worklog update
Worklog updateAndAutoAdjustRemainingEstimate(JiraServiceContext jiraServiceContext, Worklog worklog, boolean dispatchEvent)
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 methodworklog
- Updates fields of an existing worklog in the datastore (identified by its id) with the
supplied worklog. This should have been generated by a call to
validateCreate(com.atlassian.jira.bc.JiraServiceContext,com.atlassian.jira.issue.Issue,String,java.util.Date,String,String,String)
dispatchEvent
- whether or not you want to have an event dispatched on Worklog update
boolean hasPermissionToUpdate(JiraServiceContext jiraServiceContext, Worklog worklog)
Permissions.WORKLOG_EDIT_ALL
permission; ORWorklog
author and has the Permissions.WORKLOG_EDIT_OWN
permission
jiraServiceContext
- containing the User
who wishes to update the worklog and
the ErrorCollection
that will contain any errors
in calling the methodworklog
- the Worklog
the user wishes to update
boolean hasPermissionToDelete(JiraServiceContext jiraServiceContext, Worklog worklog)
Permissions.WORKLOG_DELETE_ALL
permission; ORWorklog
author and has the Permissions.WORKLOG_DELETE_OWN
permission
jiraServiceContext
- containing the User
who wishes to delete the worklog and
the ErrorCollection
that will contain any errors
in calling the methodworklog
- the Worklog
the user wishes to delete
Worklog validateCreate(JiraServiceContext jiraServiceContext, Issue issue, String timeSpent, Date startDate, String comment, String groupLevel, String roleLevelId)
hasPermissionToCreate(com.atlassian.jira.bc.JiraServiceContext,com.atlassian.jira.issue.Issue)
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 methodissue
- that will have a worklog associated with ittimeSpent
- the time spent on the workstartDate
- the date on which the work was performedcomment
- The body of the comment associated with the workloggroupLevel
- The group level visibility of the worklog (null if roleLevelId specified)roleLevelId
- The role level id visibility of the worklog (null if groupLevel specified)
WorklogService.WorklogNewEstimateResult validateCreateWithNewEstimate(JiraServiceContext jiraServiceContext, Issue issue, String timeSpent, Date startDate, String comment, String groupLevel, String roleLevelId, String newEstimate)
hasPermissionToCreate(com.atlassian.jira.bc.JiraServiceContext,com.atlassian.jira.issue.Issue)
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 methodissue
- that will have a worklog associated with ittimeSpent
- the time spent on the workstartDate
- the date on which the work was performedcomment
- The body of the comment associated with the workloggroupLevel
- The group level visibility of the worklog (null if roleLevelId specified)roleLevelId
- The role level id visibility of the worklog (null if groupLevel specified)newEstimate
- The value to change the issue's remaining estimate to.
WorklogService.WorklogAdjustmentAmountResult validateCreateWithManuallyAdjustedEstimate(JiraServiceContext jiraServiceContext, Issue issue, String timeSpent, Date startDate, String comment, String groupLevel, String roleLevelId, String adjustmentAmount)
hasPermissionToCreate(com.atlassian.jira.bc.JiraServiceContext,com.atlassian.jira.issue.Issue)
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 methodissue
- that will have a worklog associated with ittimeSpent
- the time spent on the workstartDate
- the date on which the work was performedcomment
- The body of the comment associated with the workloggroupLevel
- The group level visibility of the worklog (null if roleLevelId specified)roleLevelId
- The role level id visibility of the worklog (null if groupLevel specified)adjustmentAmount
- The amount to adjust the issue's remaining estimate by.
Worklog createWithNewRemainingEstimate(JiraServiceContext jiraServiceContext, WorklogService.WorklogNewEstimateResult worklogNewEstimate, boolean dispatchEvent)
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 methodworklogNewEstimate
- the Worklog and new estimate for the issue.dispatchEvent
- whether or not you want to have an event dispatched on Worklog creation
Worklog createWithManuallyAdjustedEstimate(JiraServiceContext jiraServiceContext, WorklogService.WorklogAdjustmentAmountResult worklogAdjustmentAmount, boolean dispatchEvent)
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 methodworklogAdjustmentAmount
- the Worklog and adjustmentAmount for the issue.dispatchEvent
- whether or not you want to have an event dispatched on Worklog creation
validateCreateWithManuallyAdjustedEstimate(com.atlassian.jira.bc.JiraServiceContext, com.atlassian.jira.issue.Issue, java.lang.String, java.util.Date, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
Worklog createAndRetainRemainingEstimate(JiraServiceContext jiraServiceContext, Worklog worklog, boolean dispatchEvent)
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 methodworklog
- Is the worklog to persist to the datastore. This should have been generated by a call to
validateCreate(com.atlassian.jira.bc.JiraServiceContext,com.atlassian.jira.issue.Issue,String,java.util.Date,String,String,String)
dispatchEvent
- whether or not you want to have an event dispatched on Worklog creation
Worklog createAndAutoAdjustRemainingEstimate(JiraServiceContext jiraServiceContext, Worklog worklog, boolean dispatchEvent)
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 methodworklog
- Is the worklog to persist to the datastore. This should have been generated by a call to
validateCreate(com.atlassian.jira.bc.JiraServiceContext,com.atlassian.jira.issue.Issue,String,java.util.Date,String,String,String)
dispatchEvent
- whether or not you want to have an event dispatched on Worklog creation
boolean hasPermissionToCreate(JiraServiceContext jiraServiceContext, Issue issue)
Permissions.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 methodissue
- the issue to add the worklog to
Worklog getById(JiraServiceContext jiraServiceContext, Long id)
jiraServiceContext
- containing the User
who wishes to create a worklog and
the ErrorCollection
that will contain any errors in calling the methodid
- uniquely identifies the worklog
List getByIssue(JiraServiceContext jiraServiceContext, Issue issue)
jiraServiceContext
- containing the User
who wishes to create a worklog and
the ErrorCollection
that will contain any errors in calling the methodissue
- the specified parent issue (not null)
List getByIssueVisibleToUser(JiraServiceContext jiraServiceContext, Issue issue)
jiraServiceContext
- containing the User
who wishes to create a worklog and
the ErrorCollection
that will contain any errors in calling the methodissue
- the specified parent issue (not null)
boolean isTimeTrackingEnabled()
APKeys.JIRA_OPTION_TIMETRACKING
is true, false
otherwise.
boolean isIssueInEditableWorkflowState(Issue issue)
issue
- the issue to see if it is in an editable store
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |