ds.granules.operation

Interface ProgressTracker

All Known Implementing Classes:

ProgressTrackerWidget

public interface ProgressTracker

The ProgressTracker encapsulates information about the status of jobs. One can also track the status of the various tasks that constitute the job.

Author:

Shrideep Pallickara

Method Summary

Modifier and Type	Method and Description
int	getCompletionStatus(java.lang.String taskIdentifier) Retrieve the completion status for a specific taskIdentifier
java.lang.String	getDeploymentStream(java.lang.String taskIdentifier) Retrieve the deployment stream associated with a given task.
java.lang.String	getIdentifier() Retrieve the Job identifier
int	getNumberOfConcurrentDeployments() Gets the number of concurrent deployments.
java.util.Enumeration<java.lang.String>	getTaskIdentifiers() Gets the task identifiers associated with the concurrent deployments
TaskLifecycleMetrics	getTaskLifecycleMetrics(java.lang.String taskIdentifier) Retrieve the TaskLifecycleMetrics associated with a given task.
boolean	isComplete() Check to see if the Job has completed.
boolean	isSuccessful() Check to see if the Job completed successfully.

Method Detail

getIdentifier

java.lang.String getIdentifier()

Retrieve the Job identifier

isComplete

boolean isComplete()

Check to see if the Job has completed.

Returns:

true if it is complete; false otherwise.

isSuccessful

boolean isSuccessful()

Check to see if the Job completed successfully.

Returns:

true if all the constiuent tasks completed successfully; false otherwise.

getNumberOfConcurrentDeployments

int getNumberOfConcurrentDeployments()

Gets the number of concurrent deployments. This reflects the number of tasks that have been deployed successfully on a set of resources.

Returns:

The number of concurrent deployments.

getTaskIdentifiers

java.util.Enumeration<java.lang.String> getTaskIdentifiers()

Gets the task identifiers associated with the concurrent deployments

Returns:

An enumeration of the task identifiers.

getTaskLifecycleMetrics

TaskLifecycleMetrics getTaskLifecycleMetrics(java.lang.String taskIdentifier)

Retrieve the TaskLifecycleMetrics associated with a given task.

Parameters:

taskIdentifier - The ID associated with a given task.

Returns:

The lifecycle metrics for the task in question.

getCompletionStatus

int getCompletionStatus(java.lang.String taskIdentifier)

Retrieve the completion status for a specific taskIdentifier

Parameters:

taskIdentifier -

Returns:

The completion status

getDeploymentStream

java.lang.String getDeploymentStream(java.lang.String taskIdentifier)

Retrieve the deployment stream associated with a given task.

Parameters:

taskIdentifier - The ID associated with a given task.

Returns:

The deployment stream associated with the given task.