@PublicApi public interface

WorklogInputParameters

com.atlassian.jira.bc.issue.worklog.WorklogInputParameters
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

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.

Public Methods

public String getComment ()

Returns
  • The body of the comment associated with the worklog

public String getErrorFieldPrefix ()

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

public String getGroupLevel ()

Returns
  • The group level visibility of the worklog

public Issue getIssue ()

Returns
  • issue that will have a worklog associated with it

public String getRoleLevelId ()

Returns
  • The role level id visibility of the worklog

public Date getStartDate ()

Returns
  • the date on which the work was performed

public String getTimeSpent ()

Returns
  • the time spent on the work

public Visibility getVisibility ()

Returns
  • The visibility level of the worklog

public Long getWorklogId ()

Returns
  • identifies the worklog that the update validation will occur against

public boolean isEditableCheckRequired ()

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