com.atlassian.bamboo.v2.build.agent

Interface AgentStatus

All Known Implementing Classes:

AbstractAgentStatus, AbstractBuildAwareAgentStatus, AgentBuildingStatus, AgentCancellingStatus, AgentIdleStatus, AgentOfflineStatus

public interface AgentStatus

What the agent is doing?

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() The display name for the thing that agent is building.
String	getImagePath() The image to use for this status
String	getLabel() The label to display
int	getOrderIndex() Used to order the AgentStatus
String	getUrl() The URL the status should point to.
boolean	isAllowDelete() Returns true if the agent is allowed to be deleted when in this state
boolean	isIdle() Returns true if the agent idle at present.

Method Detail

getOrderIndex

int getOrderIndex()

Used to order the AgentStatus

Returns:

getLabel

@NotNull
String getLabel()

The label to display

Returns:

getImagePath

@NotNull
String getImagePath()

The image to use for this status

Returns:

isAllowDelete

boolean isAllowDelete()

Returns true if the agent is allowed to be deleted when in this state

Returns:

getUrl

@Nullable
String getUrl()

The URL the status should point to. Will be prepended by the contextPath

Returns:

getDisplayName

@Nullable
String getDisplayName()

The display name for the thing that agent is building. Use in the UI.

Returns:

isIdle

boolean isIdle()

Returns true if the agent idle at present.

Returns:

agent idle status