com.atlassian.jira.rest.client.api.domain.input

Class WorklogInput

java.lang.Object

com.atlassian.jira.rest.client.api.domain.input.WorklogInput

public class WorklogInput
extends Object

Represents worklog item in JIRA. Is used to create new worklog or update existing one. Contains also estimate adjustment options which are used only to adjust change of remaining estimate (adjustEstimate and adjustEstimateValue).

Possible values for adjustEstimate and adjustEstimateValue are:

• When adjustEstimate is set to WorklogInput.AdjustEstimate.AUTO or WorklogInput.AdjustEstimate.LEAVE adjustEstimateValue is not used
• When adjustEstimate is set to WorklogInput.AdjustEstimate.NEW then remaining estimate is set to adjustEstimateValue
• When adjustEstimate is set to WorklogInput.AdjustEstimate.MANUAL then remaining estimate is reduced by adjustEstimateValue

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorklogInput.AdjustEstimate

Constructor Summary

Constructors

Constructor and Description
WorklogInput(URI self, URI issueUri, BasicUser author, BasicUser updateAuthor, String comment, org.joda.time.DateTime startDate, int minutesSpent, Visibility visibility) Creates new WorklogInput with given values.
WorklogInput(URI self, URI issueUri, BasicUser author, BasicUser updateAuthor, String comment, org.joda.time.DateTime startDate, int minutesSpent, Visibility visibility, WorklogInput.AdjustEstimate adjustEstimate, String adjustEstimateValue) Creates new WorklogInput with given values

Method Summary

Modifier and Type	Method and Description
static WorklogInput	create(URI issueUri, String comment, org.joda.time.DateTime startDate, int minutesSpent)
static WorklogInput	create(URI issueUri, String comment, org.joda.time.DateTime startDate, int minutesSpent, Visibility visibility)
boolean	equals(Object obj)
WorklogInput.AdjustEstimate	getAdjustEstimate()
String	getAdjustEstimateValue()
BasicUser	getAuthor()
String	getComment()
URI	getIssueUri()
int	getMinutesSpent()
URI	getSelf()
org.joda.time.DateTime	getStartDate()
BasicUser	getUpdateAuthor()
Visibility	getVisibility()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WorklogInput

public WorklogInput(@Nullable
                    URI self,
                    URI issueUri,
                    @Nullable
                    BasicUser author,
                    @Nullable
                    BasicUser updateAuthor,
                    @Nullable
                    String comment,
                    org.joda.time.DateTime startDate,
                    int minutesSpent,
                    @Nullable
                    Visibility visibility,
                    WorklogInput.AdjustEstimate adjustEstimate,
                    @Nullable
                    String adjustEstimateValue)

Creates new WorklogInput with given values

Parameters:

self - URI to this worklog, pass null if this is new worklog item.

issueUri - URI to destination issue

author - author of this worklog

updateAuthor - author of worklog actualization

comment - comment attached to worklog

startDate - date of work start

minutesSpent - time spend in minutes

visibility - visibility settings for this worklog

adjustEstimate - adjust estimate option

adjustEstimateValue - value for estimate adjustment. Only used when adjustEstimate is set to WorklogInput.AdjustEstimate.NEW or WorklogInput.AdjustEstimate.MANUAL

WorklogInput

public WorklogInput(@Nullable
                    URI self,
                    URI issueUri,
                    @Nullable
                    BasicUser author,
                    @Nullable
                    BasicUser updateAuthor,
                    @Nullable
                    String comment,
                    org.joda.time.DateTime startDate,
                    int minutesSpent,
                    @Nullable
                    Visibility visibility)

Creates new WorklogInput with given values. Sets adjust estimate option to default value - WorklogInput.AdjustEstimate.AUTO.

Parameters:

self - URI to this worklog, pass null if this is new worklog item.

issueUri - URI to destination issue

author - author of this worklog

updateAuthor - author of worklog actualization

comment - comment attached to worklog

startDate - date of work start

minutesSpent - time spend in minutes

visibility - visibility settings for this worklog

Method Detail

create

public static WorklogInput create(URI issueUri,
                                  @Nullable
                                  String comment,
                                  org.joda.time.DateTime startDate,
                                  int minutesSpent)

create

public static WorklogInput create(URI issueUri,
                                  @Nullable
                                  String comment,
                                  org.joda.time.DateTime startDate,
                                  int minutesSpent,
                                  @Nullable
                                  Visibility visibility)

getSelf

@Nullable
public URI getSelf()

getIssueUri

public URI getIssueUri()

getAuthor

@Nullable
public BasicUser getAuthor()

getUpdateAuthor

@Nullable
public BasicUser getUpdateAuthor()

getComment

@Nullable
public String getComment()

getStartDate

public org.joda.time.DateTime getStartDate()

getMinutesSpent

public int getMinutesSpent()

getVisibility

@Nullable
public Visibility getVisibility()

getAdjustEstimate

public WorklogInput.AdjustEstimate getAdjustEstimate()

getAdjustEstimateValue

@Nullable
public String getAdjustEstimateValue()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object