Package com.riadalabs.jira.plugins.insight.channel.external.api.facade

Interface ProgressFacade

All Known Implementing Classes:

ProgressFacadeImpl

@PublicApi
public interface ProgressFacade

Exposes methods used to track batch processes in Assets

Method Summary

Modifier and Type	Method	Description
Progress	getProgress(ProgressId id)	Get the progress for the current progress id.
boolean	isInProgress(ProgressId id)	Determine if the progress is in progress or not
boolean	isProgressFinished(ProgressId id)	Returns true if the progress is completed.
void	waitForProgressToComplete(Progress progress)	Wait for the progress to complete.

Method Details

getProgress

Progress getProgress(ProgressId id)
              throws InsightException

Get the progress for the current progress id.

Throws:

InsightException

isInProgress

boolean isInProgress(ProgressId id)
              throws InsightException

Determine if the progress is in progress or not

Returns:

true if the progress is in progress i.e. Insight is working on it

Throws:

InsightException

isProgressFinished

boolean isProgressFinished(ProgressId id)
                    throws InsightException

Returns true if the progress is completed.

Returns:

will return false if there is no progress with the current id

Throws:

InsightException

waitForProgressToComplete

void waitForProgressToComplete(Progress progress)
                        throws InterruptedException,
InsightException

Wait for the progress to complete. This call will wait for an infinite time or until an interrupted exception is thrown. Will stop waiting if the progress is updated to finished, canceled, error or if there is no progress running as specified by the parameter

Throws:

InterruptedException

InsightException