com.sun.n1.sps.model.plan
Interface PlanVariableSettings

public interface PlanVariableSettings

Encapsulates all the settings necessary to run an ExecutionPlan. Use this object to guarantee that an ExecutionPlan is executed the same way every time. This object may also store the values for a particular plan run. In that case, the values of this object are immutable.

Method Summary

java.lang.String	getDefaultUserToRunAs() Returns the default user as whom to run native steps.
java.lang.String	getDescription() Returns Description of the PlanVariableSettings.
boolean	getDetailedPreflight() Indicates whether the plan should run with detailed preflight or not.
ExecutionPlanID	getExecutionPlanID() Returns the ExecutionPlanID of the plan to be run.
PlanVariableSettingsID	getID() Return the PlanVariableSettingsID.
java.lang.String	getName() Returns the name of this object.
int	getNativeStepTimeout() Returns the native step timeout value in seconds.
VariableSettingsSource	getOverrideSettings() Returns the variables with which to run the plan.
int	getPlanThrottle() Returns the plan throttle, i.e., how many concurrent hosts may run at once.
int	getPlanTimeout() Returns the plan timeout value in seconds.
UserID	getRoxUser() Returns the user as whom to run the plan.
RunLevel	getRunLevel() Returns the RunLevel at which to run the plan.
boolean	getStatic() Indicates whether this object is a historical record of a plan run or not.
SubplanVariableSettings[]	getSubplanVariableSettings() Returns the SubplanVariableSettings objects associated with this object.
TaskID	getTaskID() Returns the TaskID associated with this object.

Method Detail

getID

PlanVariableSettingsID getID()

Return the PlanVariableSettingsID.

Returns:

a PlanVariableSettingsID or null if the object hasn't been persisted yet

getName

java.lang.String getName()

Returns the name of this object.

Returns:

a String value

getExecutionPlanID

ExecutionPlanID getExecutionPlanID()

Returns the ExecutionPlanID of the plan to be run.

Returns:

an ExecutionPlanID value

getRoxUser

UserID getRoxUser()

Returns the user as whom to run the plan.

Returns:

a UserID value

getRunLevel

RunLevel getRunLevel()

Returns the RunLevel at which to run the plan.

Returns:

a RunLevel value

getDefaultUserToRunAs

java.lang.String getDefaultUserToRunAs()

Returns the default user as whom to run native steps.

Returns:

a String value

getDetailedPreflight

boolean getDetailedPreflight()

Indicates whether the plan should run with detailed preflight or not.

Returns:

a boolean value

getPlanThrottle

int getPlanThrottle()

Returns the plan throttle, i.e., how many concurrent hosts may run at once.

Returns:

an int value

getPlanTimeout

int getPlanTimeout()

Returns the plan timeout value in seconds.

Returns:

an int value

getNativeStepTimeout

int getNativeStepTimeout()

Returns the native step timeout value in seconds.

Returns:

an int value

getOverrideSettings

VariableSettingsSource getOverrideSettings()

Returns the variables with which to run the plan.

Returns:

a VariableSettingsSource value

getStatic

boolean getStatic()

Indicates whether this object is a historical record of a plan run or not. If true, this object contains the values used by a particular plan run and is used for historical display. Static objects are immutable.

Returns:

a boolean value

getSubplanVariableSettings

SubplanVariableSettings[] getSubplanVariableSettings()

Returns the SubplanVariableSettings objects associated with this object. There is a 1-1 correlation between the SubplanPrompt objects on the TaskDescriptor object used to create this object.

Returns:

a SubplanVariableSettings[] value

getTaskID

TaskID getTaskID()

Returns the TaskID associated with this object. If this object is an historical representation of plan variable settings associated with a particular plan run, this method will return the corresponding TaskID. If this object is non-static, this method will return null.

Returns:

a TaskID value or null

getDescription

java.lang.String getDescription()

Returns Description of the PlanVariableSettings.

Returns:

this plan variablesettings description.