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
 java.lang.String getDisplayName()
          The display name for the thing that agent is building.
 java.lang.String getImagePath()
          The image to use for this status
 java.lang.String getLabel()
          The label to display
 int getOrderIndex()
          Used to order the AgentStatus
 java.lang.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
java.lang.String getLabel()
The label to display

Returns:

getImagePath

@NotNull
java.lang.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
java.lang.String getUrl()
The URL the status should point to. Will be prepended by the contextPath

Returns:

getDisplayName

@Nullable
java.lang.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


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.