Package com.atlassian.bamboo.task
Interface DecoratedTaskDefinition<T extends TaskContainer>
-
- All Superinterfaces:
EntityWithOid
,ImmutableEntityWithOid
,PluginKeyProvider
,Serializable
,TaskDefinition
,TaskIdentifier
- All Known Implementing Classes:
DecoratedTaskDefinitionImpl
@PublicApi public interface DecoratedTaskDefinition<T extends TaskContainer> extends TaskDefinition
A definition of one decorated configuration of aTaskType
- Since:
- 5.10
-
-
Field Summary
-
Fields inherited from interface com.atlassian.bamboo.task.TaskDefinition
DISABLED, ENABLED
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NotNull com.opensymphony.webwork.dispatcher.json.JSONObject
getJsonObject()
Retrieve a JSON representation of this task definition.@NotNull String
getName()
Retrieve the name of this task.T
getTaskContainer()
Retrieve the entity for which this task belongs.boolean
isValid()
Validate this Task Definition by checking whether it is linked to a taskModuleDescriptor.-
Methods inherited from interface com.atlassian.bamboo.core.EntityWithOid
setOid
-
Methods inherited from interface com.atlassian.bamboo.core.ImmutableEntityWithOid
getOid
-
Methods inherited from interface com.atlassian.bamboo.task.TaskDefinition
getConditions, getConfiguration, getEntityType, getRootDirectorySelector, setConditions, setConfiguration, setEnabled, setFinalising, setRootDirectorySelector, setUserDescription
-
Methods inherited from interface com.atlassian.bamboo.task.TaskIdentifier
getId, getPluginKey, getUserDescription, isEnabled, isFinalising
-
-
-
-
Method Detail
-
isValid
boolean isValid()
Validate this Task Definition by checking whether it is linked to a taskModuleDescriptor.- Returns:
- whether this DecoratedTaskDefinition is valid.
-
getName
@NotNull @NotNull String getName()
Retrieve the name of this task.- Returns:
- the name of this task. If the name is not defined in the TaskModuleDescriptor, the plugin key will be used.
-
getTaskContainer
@NotNull T getTaskContainer()
Retrieve the entity for which this task belongs.- Returns:
- the entity that contains this task definition.
-
getJsonObject
@NotNull @NotNull com.opensymphony.webwork.dispatcher.json.JSONObject getJsonObject() throws com.opensymphony.webwork.dispatcher.json.JSONException
Retrieve a JSON representation of this task definition.- Returns:
- a JSON representation of this task definition.
- Throws:
com.opensymphony.webwork.dispatcher.json.JSONException
-
-