@Internal public class

IndexTaskContext

extends Object
implements IndexTask
java.lang.Object
   ↳ com.atlassian.jira.config.IndexTaskContext
Known Direct Subclasses

@Internal

This class is an internal implementation detail and will change without notice.

Clients that depend on @Internal classes and interfaces can not expect to be compatible with any version other than the version they were compiled against (even minor version and milestone releases may break binary compatibility with respect to @Internal elements).

Class Overview

Context for global index operations. Only one global index operation is allowed at one time. This should be instantiated only for task querying. For submitting task please instantiate its children.

Summary

Public Constructors
IndexTaskContext()
Public Methods
String buildProgressURL(Long taskId)
This factory method is called to build a progress URL so the TaskDescriptor can allow some one to navigate to the task's "web page".
boolean equals(Object o)
String getTaskInProgressMessage(I18nHelper i18n)
int hashCode()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.config.IndexTask
From interface com.atlassian.jira.task.TaskContext

Public Constructors

public IndexTaskContext ()

Public Methods

public String buildProgressURL (Long taskId)

This factory method is called to build a progress URL so the TaskDescriptor can allow some one to navigate to the task's "web page". The URL should start with "/" and be ready for the servlet context path to be prepended.

Parameters
taskId - the id of the task. Since this is not known until task submission, this call back is informed of it once created.
Returns
  • returns a context specific progress URL that a user can go to to view the progress of a task.

public boolean equals (Object o)

public String getTaskInProgressMessage (I18nHelper i18n)

public int hashCode ()