com.atlassian.bamboo.task
Interface TaskIdentifier

All Known Subinterfaces:

CommonTaskContext, DeploymentTaskContext, InternalTaskContext, TaskContext, TaskDefinition

All Known Implementing Classes:

CommonTaskContextImpl, DecoratedTaskDefinition, DeploymentTaskContextImpl, ImmutableTaskDefinition, TaskContextImpl, TaskDefinitionImpl

public interface TaskIdentifier

This interface defines a configured instance of a TaskType

Since:

3.1

See Also:

TaskType, TaskContext

Method Summary

long	getId()
java.lang.String	getPluginKey()
java.lang.String	getUserDescription()
boolean	isEnabled()
boolean	isFinalising()

Method Detail

getId

long getId()

Returns:

the id of this configuration. Unique within the given context (e.g. Job

getPluginKey

@NotNull
java.lang.String getPluginKey()

Returns:

Complete key of the task type plugin module

getUserDescription

@Nullable
java.lang.String getUserDescription()

Returns:

the description of the task as defined by the user

isEnabled

boolean isEnabled()

Returns:

whether the task is enabled or disabled

isFinalising

boolean isFinalising()

Returns:

true if the task should be run in finalisation phase