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

public interface SubplanVariableSettings

Used by PlanVariableSettings to mirror the structure of SubplanPrompt for Plan Variable Settings persistence. The function of this object is allow the PlanVariableSettings object to take ownership of the nested SubplanPrompt objects and persist them. This object can also recreate a similar SubplanPrompt, equal in all data members, but not the same object.

Method Summary

java.lang.String	getHostSetName() Returns the HostSet name entered for this subplan.
SubplanVariableSettingsID	getID() Returns the ObjectID associated with this object.
java.lang.String	getLimitToHostSet() Sets the HostSet name entered for this subplan.
int	getOrder() Returns the relative order of this object with respect to the other children of the same PlanVariableSettings parent.
PlanVariableSettingsID	getParentID() Returns the PlanVariableSettingsID that points to this object's parent.
SubplanComponentVariableSettings[]	getSubplanComponentVariableSettings() Returns the SubplanComponentVariableSettings objects which are children of this object.
ExecutionPlanID	getSubplanID() Returns the ExecutionPlanID corresponding to the subplan for this object's SubplanPrompt.
java.lang.String	getSubplanName() Returns the String corresponding to the subplan name for this object's SubplanPrompt.
HostID[]	getTargets() Returns the targets to which this object's SubplanPrompt was originally targeted.

Method Detail

getID

SubplanVariableSettingsID getID()

Returns the ObjectID associated with this object. Changing the value returned by this method does not change the object value.

Returns:

a SubplanVariableSettingsID value or null if this object has not been persisted yet.

getParentID

PlanVariableSettingsID getParentID()

Returns the PlanVariableSettingsID that points to this object's parent. Changing the value returned by this method does not change the object value.

Returns:

a PlanVariableSettingsID value

getSubplanID

ExecutionPlanID getSubplanID()

Returns the ExecutionPlanID corresponding to the subplan for this object's SubplanPrompt. Changing the value returned by this method does not change the object value.

Returns:

an ExecutionPlanID value

getSubplanName

java.lang.String getSubplanName()

Returns the String corresponding to the subplan name for this object's SubplanPrompt. Changing the value returned by this method does not change the object value.

Returns:

a String value

getTargets

HostID[] getTargets()

Returns the targets to which this object's SubplanPrompt was originally targeted. Changing the value returned by this method does not change the object value.

Returns:

a HostID[] value

getHostSetName

java.lang.String getHostSetName()

Returns the HostSet name entered for this subplan. This value is for display purposes only. It does not change the actual hosts on which the subplan is run. To get the actual set of hosts on which a subplan is run, use getTargets. Changing the value returned by this method does not change the object value.

Returns:

a String value

getLimitToHostSet

java.lang.String getLimitToHostSet()

Sets the HostSet name entered for this subplan. This value is for display purposes only. It does not change the actual hosts on which the subplan is run. To affect the set of hosts on which a subplan is run, use setTargets(HostID[]). It is the caller's responsibility to set the proper set of hosts including resolving the hostset name to a set of hosts, if applicable. The first 97 characters of the passed value will be retained, all others discarded. Future modification of the value passed to this method will not change this object's value.

Parameters:

inHostSetName - a String value

getOrder

int getOrder()

Returns the relative order of this object with respect to the other children of the same PlanVariableSettings parent.

Returns:

an int value

getSubplanComponentVariableSettings

SubplanComponentVariableSettings[] getSubplanComponentVariableSettings()

Returns the SubplanComponentVariableSettings objects which are children of this object. Changing the value returned by this method does not change the object value.

Returns:

a SubplanComponentVariableSettings[] value