com.sun.n1.sps.model.host
Interface UpgradeTaskStatus


public interface UpgradeTaskStatus

This class encapsulates the status of an upgrade task. The status includes individual node status of each node being upgraded.


Method Summary
 UpgradeNodeStatus[] getAllNodeStatus()
          Returns an array of all node status objects.
 java.lang.String getDetail()
          Returns task level detail messages if available.
 UpgradeTaskID getID()
          Returns the upgrade task ID.
 int getNumNodes()
          Returns the total number of nodes affected by this task.
 UpgradeTaskState getTaskState()
          Returns the current task state.
 boolean isAborted()
          Returns true if the upgrade task was aborted.
 boolean isComplete()
          Returns true if the task is complete.
 

Method Detail

getID

UpgradeTaskID getID()
Returns the upgrade task ID.

Returns:
the upgrade task ID.

isComplete

boolean isComplete()
Returns true if the task is complete.

Returns:
true if the task is complete.

getNumNodes

int getNumNodes()
Returns the total number of nodes affected by this task.

Returns:
the total number of nodes affected by this task.

isAborted

boolean isAborted()
Returns true if the upgrade task was aborted.

Returns:
true if the upgrade task was aborted.

getDetail

java.lang.String getDetail()
Returns task level detail messages if available. Task level detail messages are currently available if the task was interrupted or if no nodes were found to upgrade.

Returns:
task level detail messages.

getTaskState

UpgradeTaskState getTaskState()
Returns the current task state.

Returns:
the current task state.

getAllNodeStatus

UpgradeNodeStatus[] getAllNodeStatus()
Returns an array of all node status objects.

Returns:
an array of all node status objects.