com.atlassian.jira.bc.issue.worklog
Class WorklogInputParametersImpl

java.lang.Object
  extended by com.atlassian.jira.bc.issue.worklog.WorklogInputParametersImpl
All Implemented Interfaces:
WorklogAdjustmentAmountInputParameters, WorklogInputParameters, WorklogNewEstimateInputParameters

public class WorklogInputParametersImpl
extends Object
implements WorklogInputParameters, WorklogNewEstimateInputParameters, WorklogAdjustmentAmountInputParameters

Implementation of the WorklogInputParameters, WorklogNewEstimateInputParameters and WorklogAdjustmentAmountInputParameters interfaces. Static builder methods are provided for convenience.

Since:
v4.2
See Also:
WorklogInputParametersImpl.Builder

Nested Class Summary
static class WorklogInputParametersImpl.Builder
          A fluent-style Builder for constructing WorklogInputParameters, WorklogNewEstimateInputParameters and WorklogAdjustmentAmountInputParameters objects.
 
Method Summary
static WorklogInputParametersImpl.Builder builder()
           
 boolean equals(Object o)
           
 String getAdjustmentAmount()
           
 String getComment()
           
 String getErrorFieldPrefix()
           
 String getGroupLevel()
           
 Issue getIssue()
           
 String getNewEstimate()
           
 String getRoleLevelId()
           
 Date getStartDate()
           
 String getTimeSpent()
           
 Long getWorklogId()
           
 int hashCode()
           
 boolean isEditableCheckRequired()
           
static WorklogInputParametersImpl.Builder issue(Issue issue)
           
static WorklogInputParametersImpl.Builder timeSpent(String timeSpent)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getWorklogId

public Long getWorklogId()
Specified by:
getWorklogId in interface WorklogInputParameters
Returns:
identifies the worklog that the update validation will occur against

getIssue

public Issue getIssue()
Specified by:
getIssue in interface WorklogInputParameters
Returns:
issue that will have a worklog associated with it

getTimeSpent

public String getTimeSpent()
Specified by:
getTimeSpent in interface WorklogInputParameters
Returns:
the time spent on the work

getStartDate

public Date getStartDate()
Specified by:
getStartDate in interface WorklogInputParameters
Returns:
the date on which the work was performed

getComment

public String getComment()
Specified by:
getComment in interface WorklogInputParameters
Returns:
The body of the comment associated with the worklog

getGroupLevel

public String getGroupLevel()
Specified by:
getGroupLevel in interface WorklogInputParameters
Returns:
The group level visibility of the worklog

getRoleLevelId

public String getRoleLevelId()
Specified by:
getRoleLevelId in interface WorklogInputParameters
Returns:
The role level id visibility of the worklog

getNewEstimate

public String getNewEstimate()
Specified by:
getNewEstimate in interface WorklogNewEstimateInputParameters
Returns:
The value to change the issue's remaining estimate to.

getAdjustmentAmount

public String getAdjustmentAmount()
Specified by:
getAdjustmentAmount in interface WorklogAdjustmentAmountInputParameters
Returns:
The amount to adjust the issue's remaining estimate by.

isEditableCheckRequired

public boolean isEditableCheckRequired()
Specified by:
isEditableCheckRequired in interface WorklogInputParameters
Returns:
do we require a check to be performed to see if the issue is in an editable state?

getErrorFieldPrefix

public String getErrorFieldPrefix()
Specified by:
getErrorFieldPrefix in interface WorklogInputParameters
Returns:
the prefix to use when populating the error collection against specific fields. May be null to signify no prefix.

builder

public static WorklogInputParametersImpl.Builder builder()
Returns:
a blank Builder to use for WorklogInputParameters construction

issue

public static WorklogInputParametersImpl.Builder issue(Issue issue)
Parameters:
issue - the issue
Returns:
a Builder with the Issue pre-populated

timeSpent

public static WorklogInputParametersImpl.Builder timeSpent(String timeSpent)
Parameters:
timeSpent - the amount of time spent
Returns:
a Builder with the time spent pre-populated

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object


Copyright © 2002-2012 Atlassian. All Rights Reserved.