com.sun.n1.sps.model.install
Interface InstalledComponent

public interface InstalledComponent

An installed component represents a component that has been installed on a particular target in a particular path with a particular generated variable settings.

Method Summary

ComponentID	getComponentID() The ID of the component that has been installed.
java.lang.String	getHostTypeName() Returns the name of the HostType associated with this installed component.
InstalledComponentID	getID() The ID of this installed component.
java.lang.String	getInstallBlockName() The name of the install block within the associated component definition used to install this component
java.util.Date	getInstallDate() The date this component was installed
java.lang.String	getInstallPath() The path in which the component was installed, in universal format.
InstalledComponentID	getParentContainerID() The ID of the parent installed component that directly installed this component.
java.lang.String	getParentContainerRefName() The name of the component ref used to install this component.
ExecutionPlanID	getPlanID() The plan that installed the component.
InstalledComponentID	getRootContainerID() The ID of the top-level root installed component whose installation led to the installation of this component.
TaskID	getTaskID() The task that installed the component
java.util.Date	getUninstallDate() The date this component was uninstalled
GeneratedVariableSettingsID	getVariableSettingsID() The generated variable settings used to configure the installed component.
boolean	isInstalled() Whether or not the installed component is currently installed

Method Detail

getID

InstalledComponentID getID()

The ID of this installed component.

getComponentID

ComponentID getComponentID()

The ID of the component that has been installed.

getInstallPath

java.lang.String getInstallPath()

The path in which the component was installed, in universal format.

getParentContainerID

InstalledComponentID getParentContainerID()

The ID of the parent installed component that directly installed this component. Null if-and-only-if this component is a top-level component.

getParentContainerRefName

java.lang.String getParentContainerRefName()

The name of the component ref used to install this component. Null iff this component is a top-level component. If non null, then this member names a component ref within the containing component that references this component.

getRootContainerID

InstalledComponentID getRootContainerID()

The ID of the top-level root installed component whose installation led to the installation of this component. If this component is a top-level component, then the ID of this component is returned.

getVariableSettingsID

GeneratedVariableSettingsID getVariableSettingsID()

The generated variable settings used to configure the installed component.

getTaskID

TaskID getTaskID()

The task that installed the component

getPlanID

ExecutionPlanID getPlanID()

The plan that installed the component. Note that this may be a subplan of the top level plan associated with the TaskID.

getInstallDate

java.util.Date getInstallDate()

The date this component was installed

Returns:

a Date which may be null if this component has not been installed

getUninstallDate

java.util.Date getUninstallDate()

The date this component was uninstalled

Returns:

a Date which may be null if this component has not been uninstalled

getInstallBlockName

java.lang.String getInstallBlockName()

The name of the install block within the associated component definition used to install this component

isInstalled

boolean isInstalled()

Whether or not the installed component is currently installed

getHostTypeName

java.lang.String getHostTypeName()

Returns the name of the HostType associated with this installed component. If the Component being installed is a TargetableComponent, the HostType of the host created will be returned. Otherwise, this value will be null.

Returns:

a String value or null