org.jboss.as.controller.client.helpers.domain

Interface DeploymentPlanResult

All Known Implementing Classes:

DeploymentPlanResultImpl

public interface DeploymentPlanResult

Encapsulates the results of executing a DeploymentPlan.

Author:

Brian Stansberry

Method Summary

Modifier and Type	Method and Description
Map<UUID,DeploymentActionResult>	getDeploymentActionResults() Gets the results of the DeploymentActions associated with the deployment set plan.
DeploymentPlan	getDeploymentPlan() Gets the deployment plan that lead to this result.
UUID	getId() Gets the unique id of the deployment plan.
InvalidDeploymentPlanException	getInvalidDeploymentPlanException() Gets the exception describing the problem with a deployment plan that is not valid.
Map<String,ServerGroupDeploymentPlanResult>	getServerGroupResults() Gets the results for each server group.
boolean	isValid() Gets whether the deployment plan was valid.

Method Detail

getId

UUID getId()

Gets the unique id of the deployment plan.

Returns:

the id. Will not be null

getDeploymentPlan

DeploymentPlan getDeploymentPlan()

Gets the deployment plan that lead to this result.

Returns:

the deployment plan. Will not be null

isValid

boolean isValid()

Gets whether the deployment plan was valid. If false see getInvalidDeploymentPlanException() to for more information on how the plan was invalid.

Returns:

true if the plan was valid; false otherwise

getInvalidDeploymentPlanException

InvalidDeploymentPlanException getInvalidDeploymentPlanException()

Gets the exception describing the problem with a deployment plan that is not valid.

Returns:

the exception or null if the plan is valid

getServerGroupResults

Map<String,ServerGroupDeploymentPlanResult> getServerGroupResults()

Gets the results for each server group.

Returns:

map of server group results, keyed by server group name

getDeploymentActionResults

Map<UUID,DeploymentActionResult> getDeploymentActionResults()

Gets the results of the DeploymentActions associated with the deployment set plan.

Returns:

map of deployment action results, keyed by deployment action id