Summary: Methods | [Expand All]
@PublicApi public interface

WorklogResult

com.atlassian.jira.bc.issue.worklog.WorklogResult
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 interface which defines the base result of a WorklogService validation call. This interface has two sub-interfaces for specifying WorklogNewEstimateResult and WorklogAdjustmentAmountResult, which are the expected input types for their respective "do" service calls.

To create instances of this class, see the WorklogResultFactory.

See Also

Summary

Public Methods
Worklog getWorklog()
boolean isEditableCheckRequired()

Public Methods

public Worklog getWorklog ()

Returns
  • the worklog constructed during validation, possibly null.

public boolean isEditableCheckRequired ()

Returns
  • true if the editable issue check is required; false otherwise. Note that this should only be false when creating worklogs during issue transitions.