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

All Superinterfaces:

PluginMember

public interface ExecutionPlan
extends PluginMember

Encapsulates an Execution Plan, a sequence of ExecSteps.

Method Summary

CategoryIDSet	getCategories() Returns a set of IDs of the categories that this plan is a member of.
java.lang.String	getDescription() Returns the description of this object.
ExecutionMode	getExecutionMode() Returns the Execution mode for this plan.
java.lang.String	getFullName() Returns the full name of the plan, which is defined as the full path prepended to the name.
ExecutionPlanID	getID() Returns the ID of this object, or null if this object has not yet been saved.
java.lang.String	getLimitToHostSet() Returns the name of the host set whose members define the allowed targets for this plan, or null if there is no limit on the targets for this plan.
VariableSettingsSource	getLocalVars() Returns the variables associated with this plan.
java.lang.String	getName() Returns the name of this object.
PromptParamList	getParams() Returns the formal parameters declared by this plan.
FolderID	getPath() Returns the path that this plan is located in.
ExecutionPlanID	getRootID() Returns the root ID of this object.
java.lang.String	getSchemaVersion() Gets the schema version used by this plan.
java.util.Date	getTimeStamp() Returns the timestamp representing the time that the object was saved, or null if the object has not yet been saved.
UserID	getUserID() Returns the user id of the user that saved the object.
VersionNumber	getVersionNumber() Returns the current version of the object.
Visibility	getVisibility() Returns the current visibility of this object.
boolean	isCompositePlan() Whether this is a composite plan
boolean	isSimplePlan() Whether this is a simple plan
void	writeToXML(java.io.OutputStream out) Writes the contents of this plan to the given output stream, in its canonical XML format.

Methods inherited from interface com.sun.n1.sps.model.PluginMember

getPluginID

Method Detail

getID

ExecutionPlanID getID()

Returns the ID of this object, or null if this object has not yet been saved.

Returns:

The ID of this object.

getPath

FolderID getPath()

Returns the path that this plan is located in. All plans in the same version as this plan have the same path. By default, the root folder is returned.

Returns:

The plan path.

getFullName

java.lang.String getFullName()

Returns the full name of the plan, which is defined as the full path prepended to the name.

Returns:

The plan full name; if the folder cannot be resolved, the folder part of the fullname will be "unknown-folder".

getUserID

UserID getUserID()

Returns the user id of the user that saved the object.

Returns:

The user id of the user that saved the object if available, null otherwise.

getTimeStamp

java.util.Date getTimeStamp()

Returns the timestamp representing the time that the object was saved, or null if the object has not yet been saved. Modification of the result will not affect this object.

Returns:

The time the object was last saved.

getVersionNumber

VersionNumber getVersionNumber()

Returns the current version of the object.

Returns:

The version number.

getLimitToHostSet

java.lang.String getLimitToHostSet()

Returns the name of the host set whose members define the allowed targets for this plan, or null if there is no limit on the targets for this plan.

Returns:

The name of the limiting host set.

getRootID

ExecutionPlanID getRootID()

Returns the root ID of this object. The root ID is the ID of the first version in the version tree (i.e. the ultimate ancestor).

Returns:

The root ID.

getSchemaVersion

java.lang.String getSchemaVersion()

Gets the schema version used by this plan. By default, this value is "5.2".

Returns:

The schema version

getLocalVars

VariableSettingsSource getLocalVars()

Returns the variables associated with this plan.

Returns:

The variables associated with this plan.

isCompositePlan

boolean isCompositePlan()

Whether this is a composite plan

Returns:

true if this plan is a composite plan, else false.

isSimplePlan

boolean isSimplePlan()

Whether this is a simple plan

Returns:

true if this plan is a simple plan, else false.

getCategories

CategoryIDSet getCategories()

Returns a set of IDs of the categories that this plan is a member of. Modifications to the result will not affect this object.

Returns:

The IDs of the categories that this plan is a member of

writeToXML

void writeToXML(java.io.OutputStream out)

Writes the contents of this plan to the given output stream, in its canonical XML format. The canonical XML format of a plan is equivalent to the XML originally used to create the plan, but need not be textually equal. The canonical XML format may contain different whitespace, may reorder the attributes of various elements, and may omit optional attributes whose value is empty or equal to their default value.

Output is written using UTF-8 encoding.

Parameters:

out - the stream to write to.

getParams

PromptParamList getParams()

Returns the formal parameters declared by this plan.

Returns:

the plan parameters.

getExecutionMode

ExecutionMode getExecutionMode()

Returns the Execution mode for this plan.

Returns:

The Execution Mode for this plan.

getVisibility

Visibility getVisibility()

Returns the current visibility of this object.

Returns:

The visibility of this object.

getName

java.lang.String getName()

Returns the name of this object.

Returns:

The name of this object.

getDescription

java.lang.String getDescription()

Returns the description of this object.

Returns:

The description of this object.