com.riadalabs.jira.plugins.insight.services.progress.model

Class Progress

java.lang.Object

com.riadalabs.jira.plugins.insight.services.progress.model.Progress

All Implemented Interfaces:

Serializable

@PublicApi
public class Progress
extends Object
implements Serializable

Since:

4.5

Author:

Fredrik Karbing

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Progress.Result
static class	Progress.Status

Method Summary

Modifier and Type	Method and Description
void	addStep(ProgressStep progressStep)
int	amountOfSteps()
void	cancelled()
int	currentStep()
void	decrementTotalWorkUnits(int ignoredWorkUnits)
void	finishedError()
void	finishedOk()
String	getActor()
String	getCurrentStepDescription()
int	getCurrentStepTotalWorkUnits()
String	getCurrentWorkDescription()
int	getCurrentWorkUnits()
Date	getFinishedDate()
int	getMaxStepIndex()
ProgressId	getProgressId()
Integer	getProgressInPercent()
ArrayList<ProgressStep>	getProgressSteps()
Progress.Result	getResult()
com.riadalabs.jira.plugins.insight.services.progress.result.ProgressResult	getResultData()
String	getResultMessage()
Date	getStartDate()
Progress.Status	getStatus()
int	getStepIndex()
int	getTotalWorkUnits()
void	incrementCurrentWorkUnits()
void	incrementCurrentWorkUnits(int incrementCurrentWorkUnits)
boolean	isCancelled()
boolean	isCategory(com.riadalabs.jira.plugins.insight.services.progress.ProgressCategory category)
boolean	isError()
boolean	isFinished()
boolean	isInProgress()
static Progress	newSingleStep(ProgressId progressId, String overallDescription, String actor, int totalWorkUnits)
static Progress	newWithSteps(ProgressId progressId, String actor, int numberOfSteps)
boolean	nextStep()
void	setCurrentWorkDescription(String currentWorkDescription)
void	setCurrentWorkUnits(int currentWorkUnits)
void	setResultData(com.riadalabs.jira.plugins.insight.services.progress.result.ProgressResult resultData)
void	setResultMessage(String resultMessage)
void	setTotalWorkUnits(int totalWorkUnits)
String	toString() Note! Uses reflection, so be wary, intended for DEBUG and ERROR log.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

newSingleStep

public static Progress newSingleStep(ProgressId progressId,
                                     String overallDescription,
                                     String actor,
                                     int totalWorkUnits)

newWithSteps

public static Progress newWithSteps(ProgressId progressId,
                                    String actor,
                                    int numberOfSteps)

addStep

public void addStep(ProgressStep progressStep)
             throws InsightProgressIllegalStateException

Throws:

InsightProgressIllegalStateException

getProgressId

public ProgressId getProgressId()

amountOfSteps

public int amountOfSteps()

currentStep

public int currentStep()

getCurrentStepDescription

public String getCurrentStepDescription()

nextStep

public boolean nextStep()

isCategory

public boolean isCategory(com.riadalabs.jira.plugins.insight.services.progress.ProgressCategory category)

isInProgress

public boolean isInProgress()

isFinished

public boolean isFinished()

isError

public boolean isError()

isCancelled

public boolean isCancelled()

finishedOk

public void finishedOk()

cancelled

public void cancelled()

finishedError

public void finishedError()

getStatus

public Progress.Status getStatus()

getResult

public Progress.Result getResult()

getResultData

public com.riadalabs.jira.plugins.insight.services.progress.result.ProgressResult getResultData()

setResultData

public void setResultData(com.riadalabs.jira.plugins.insight.services.progress.result.ProgressResult resultData)

getResultMessage

public String getResultMessage()

setResultMessage

public void setResultMessage(String resultMessage)

getStartDate

public Date getStartDate()

getFinishedDate

public Date getFinishedDate()

getActor

public String getActor()

toString

public String toString()

Note! Uses reflection, so be wary, intended for DEBUG and ERROR log.

Overrides:

toString in class Object

setCurrentWorkDescription

public void setCurrentWorkDescription(String currentWorkDescription)

getProgressInPercent

public Integer getProgressInPercent()

getCurrentWorkUnits

public int getCurrentWorkUnits()

getCurrentStepTotalWorkUnits

public int getCurrentStepTotalWorkUnits()

getCurrentWorkDescription

public String getCurrentWorkDescription()

getTotalWorkUnits

public int getTotalWorkUnits()

setCurrentWorkUnits

public void setCurrentWorkUnits(int currentWorkUnits)

incrementCurrentWorkUnits

public void incrementCurrentWorkUnits(int incrementCurrentWorkUnits)

setTotalWorkUnits

public void setTotalWorkUnits(int totalWorkUnits)

decrementTotalWorkUnits

public void decrementTotalWorkUnits(int ignoredWorkUnits)

incrementCurrentWorkUnits

public void incrementCurrentWorkUnits()

getProgressSteps

public ArrayList<ProgressStep> getProgressSteps()

getMaxStepIndex

public int getMaxStepIndex()

getStepIndex

public int getStepIndex()