com.sun.n1.sps.model.executor
Interface SubplanInfo

public interface SubplanInfo

Contains the persistent form of the information chosen by a user to run a subplan of a main plan. This information may include the following:

• A list of appropriate targets.
• The component builds selected for this subplan.
• The variable settings chosen for this subplan.

  Method Summary

  ComponentID[]	getComponentIDs() Returns the array of ComponentIDs chosen for this subplan run.
  GeneratedVariableSettingsID[]	getGeneratedVariableSettingsIDs() Returns the GeneratedVariableSettingsID chosen for this subplan run.
  HostID[]	getInitialHostIDs() Returns the array of HostIDs corresponding to initial hosts for these targets.
  ExecutionPlanID	getSubplanID() Returns the planID of the subplan.
  int	getSubplanIndex() Returns the index of this subplan in the overall plan.
  java.lang.String	getSubplanName() Returns the subplan name represented by this SubplanInfo.
  Target[]	getTargets() Return the array of Targets representing the targets for this subplan.
  TaskID	getTaskID() Returns the owning task ID.

  Method Detail

  getTaskID

  TaskID getTaskID()

  Returns the owning task ID.

  Returns:

  The TaskID value.

  getSubplanName

  java.lang.String getSubplanName()

  Returns the subplan name represented by this SubplanInfo.

  Returns:

  The subplan name represented by this SubplanInfo.

  getSubplanID

  ExecutionPlanID getSubplanID()

  Returns the planID of the subplan.

  Returns:

  the planID of the subplan.

  getTargets

  Target[] getTargets()

  Return the array of Targets representing the targets for this subplan.

  Returns:

  An array of Targets.

  getInitialHostIDs

  HostID[] getInitialHostIDs()

  Returns the array of HostIDs corresponding to initial hosts for these targets.

  Returns:

  The array of HostIDs corresponding to initial hosts for these targets.

  getComponentIDs

  ComponentID[] getComponentIDs()

  Returns the array of ComponentIDs chosen for this subplan run. Note that these ComponentIDs are ordered to match the order of component install steps in the plan.

  Returns:

  The ComponentIDs chosen for this subplan run.

  getGeneratedVariableSettingsIDs

  GeneratedVariableSettingsID[] getGeneratedVariableSettingsIDs()

  Returns the GeneratedVariableSettingsID chosen for this subplan run. Note that these are ordered to match the componentIDs[] array.

  Returns:

  An array of GeneratedVariableSettingsID.

  getSubplanIndex

  int getSubplanIndex()

  Returns the index of this subplan in the overall plan.

  Returns:

  the index of this subplan in the overall plan.