com.sun.n1.sps.model.component
Interface SummaryComponent

All Superinterfaces:

PluginMember

All Known Subinterfaces:

Component

public interface SummaryComponent
extends PluginMember

Summary view of a Component object. Information about the component content and containing categories is not available in its summary view.

In general, the summary view of a component can be more efficiently retrieved than the component itself. Accordingly, it is recommended that clients which only need access to the data provided within the summary view retrieve and use the summary view rather than the complete component.

Method Summary

java.lang.String	getAuthor() Returns the author of this component.
java.lang.String	getDescription() Returns the description of this object.
java.lang.String	getExtendsTypeName() Returns the name of the base component type extended by this component, or null if this is a non-derived component.
java.lang.String	getFullName() Returns the full name of the component, which is defined as the full path prepended to the name.
ComponentID	getID() Returns the ID of this object, or null if this object has not yet been saved.
java.lang.String	getLabel() Returns the label of this object.
java.lang.String[]	getLocalIgnorePaths() Returns the locally declared paths to ignore when comparing the snapshots created by this component.
java.lang.String	getLocalInstallPath() Returns the locally declared install path of this component.
java.lang.String	getLocalLimitToHostSet() Returns the locally declared name of the host set whose members define the allowed targets for this component.
Modifier	getModifier() Returns the modifier of this component.
java.lang.String	getName() Returns the name of this object.
FolderID	getPath() Returns the path that this component is located in.
java.lang.String	getPlatform() Returns the name of the platform host set whose members define the allowed physical targets for this component.
ComponentID	getRootID() Returns the root ID of this object.
java.lang.String	getSoftwareVendor() Returns the software vendor that created this component.
java.util.Date	getTimeStamp() Returns the timestamp representing the time that this component was saved, or null if this object has not yet been saved.
UserID	getUserID() Returns the user id of the user that saved this component.
VersionNumber	getVersionNumber() Returns the current version of this component.
Visibility	getVisibility() Returns the current visibility of this object.
boolean	isDerivedComponent() Returns true if this component is derived from another component, false otherwise.
boolean	isSimpleComponent() Returns true if this component is a simple component, false if this component is a composite component.

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

getPluginID

Method Detail

getID

ComponentID 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 component is located in. All components in the same version as this component have the same path.

Returns:

the component path

getFullName

java.lang.String getFullName()

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

Returns:

the component full name; if the folder cannot be resolved, the folder part of the fullname will be FolderID.UNKNOWN_FOLDER.

getLabel

java.lang.String getLabel()

Returns the label of this object. This is typically much shorter than the description field, is used to distinguish this component from others in the same version tree, and often represents a client-defined version number of some sort.

Returns:

the label of this object

getLocalLimitToHostSet

java.lang.String getLocalLimitToHostSet()

Returns the locally declared name of the host set whose members define the allowed targets for this component. In a derived component, null indicates that the base component limitToHostSet should be used. In a non-derived component, null indicates that there is no restriction on the targets.

Returns:

the name of the limiting host set.

See Also:

Component.getLimitToHostSet()

getExtendsTypeName

java.lang.String getExtendsTypeName()

Returns the name of the base component type extended by this component, or null if this is a non-derived component.

Returns:

the name of the base component type

See Also:

isDerivedComponent()

getSoftwareVendor

java.lang.String getSoftwareVendor()

Returns the software vendor that created this component.

Returns:

the component software vendor

getAuthor

java.lang.String getAuthor()

Returns the author of this component. This need not correspond to a ROX user.

Returns:

the component author.

getLocalInstallPath

java.lang.String getLocalInstallPath()

Returns the locally declared install path of this component. The value returned may contain substitution variable references. Expected to be null for and only for derived components.

Returns:

the local component install path.

getLocalIgnorePaths

java.lang.String[] getLocalIgnorePaths()

Returns the locally declared paths to ignore when comparing the snapshots created by this component. The values returned may contain substitution variable references. Modification of the result will not affect this object.

Returns:

the locally declared ignore paths.

isDerivedComponent

boolean isDerivedComponent()

Returns true if this component is derived from another component, false otherwise. The component is derived if-and-only-if the extendsTypeName is non-null.

See Also:

getExtendsTypeName()

isSimpleComponent

boolean isSimpleComponent()

Returns true if this component is a simple component, false if this component is a composite component. A simple component references only a single resource, and is guaranteed to have a non-null resource install spec. A composite component references zero or more other components and is guaranteed to have a null resource install spec.

getRootID

ComponentID 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.

getModifier

Modifier getModifier()

Returns the modifier of this component. Defaults to Modifier.NONE.

Returns:

the modifier

getVersionNumber

VersionNumber getVersionNumber()

Returns the current version of this component.

Returns:

the current version of this component.

getPlatform

java.lang.String getPlatform()

Returns the name of the platform host set whose members define the allowed physical targets for this component. Logically, this host set represents the hosts which have the operating system platform that the component may be installed on.

Returns:

the name of the platform host set.

getTimeStamp

java.util.Date getTimeStamp()

Returns the timestamp representing the time that this component was saved, or null if this object has not yet been saved.

Returns:

the time this object was last saved.

getUserID

UserID getUserID()

Returns the user id of the user that saved this component.

Returns:

thre user id.

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.