com.atlassian.jira.bc.issue.worklog

Interface WorklogInputParameters

All Known Subinterfaces:

WorklogAdjustmentAmountInputParameters, WorklogNewEstimateInputParameters

All Known Implementing Classes:

WorklogInputParametersImpl

@PublicApi
public interface WorklogInputParameters

An aggregate of the input parameters required to validate and perform worklog creation and update service calls. This interface has two sub-interfaces: WorklogNewEstimateInputParameters and WorklogAdjustmentAmountInputParameters. They are used for specifying additional information to validation service calls.

To build instances of this class, see the WorklogInputParametersImpl builder methods.

Since:

v4.2

See Also:

WorklogInputParametersImpl.builder(), WorklogInputParametersImpl.issue(com.atlassian.jira.issue.Issue), WorklogInputParametersImpl.timeSpent(String)

Method Summary

Modifier and Type	Method and Description
String	getComment()
String	getErrorFieldPrefix()
String	getGroupLevel()
Issue	getIssue()
String	getRoleLevelId()
Date	getStartDate()
String	getTimeSpent()
Visibility	getVisibility()
Long	getWorklogId()
boolean	isEditableCheckRequired()

Method Detail

getWorklogId

Long getWorklogId()

Returns:

identifies the worklog that the update validation will occur against

getIssue

Issue getIssue()

Returns:

issue that will have a worklog associated with it

getTimeSpent

String getTimeSpent()

Returns:

the time spent on the work

getStartDate

Date getStartDate()

Returns:

the date on which the work was performed

getComment

String getComment()

Returns:

The body of the comment associated with the worklog

getGroupLevel

String getGroupLevel()

Returns:

The group level visibility of the worklog

getRoleLevelId

String getRoleLevelId()

Returns:

The role level id visibility of the worklog

getVisibility

Visibility getVisibility()

Returns:

The visibility level of the worklog

isEditableCheckRequired

boolean isEditableCheckRequired()

Returns:

do we require a check to be performed to see if the issue is in an editable state?

getErrorFieldPrefix

String getErrorFieldPrefix()

Returns:

the prefix to use when populating the error collection against specific fields. May be null to signify no prefix.