com.metamatrix.common.config.api
Interface ComponentObject

All Superinterfaces:

BaseObject, java.lang.Cloneable, java.lang.Comparable

All Known Subinterfaces:

AuthenticationProvider, ComponentDefn, Configuration, ConnectorBinding, DeployedComponent, ExtensionModule, Host, ProductServiceConfig, ResourceDescriptor, ServiceComponentDefn, SharedResource, VMComponentDefn

All Known Implementing Classes:

BasicAuthenticationProvider, BasicComponentDefn, BasicComponentObject, BasicConfiguration, BasicConnectorBinding, BasicDeployedComponent, BasicExtensionModule, BasicHost, BasicProductServiceConfig, BasicResourceDescriptor, BasicServiceComponentDefn, BasicSharedResource, BasicVMComponentDefn

public interface ComponentObject
extends BaseObject

A ComponentObject represents a physical piece of the configuration and deployment tree. The basic information contained in it is - id (name), type and properties.

Method Summary

void	accept(ConfigurationVisitor visitor)
ComponentTypeID	getComponentTypeID() Returns the component type
java.lang.String	getCreatedBy() Returns the principal who created this type
java.util.Date	getCreatedDate() Returns the Date this type was created
java.lang.String	getDescription() Returns the description of this component definition
java.lang.String	getLastChangedBy() Returns the principal who last modified this type
java.util.Date	getLastChangedDate() Returns the Date this type was last changed
java.lang.String	getName() Returns the name
java.util.Properties	getProperties() Returns the current unmodifiable properties for the component
java.lang.String	getProperty(java.lang.String name) Returns a property value for the given property name
boolean	isDependentUpon(BaseID componentObjectId) Returns true if this object is dependent upon the specified ComponentObjectID

Methods inherited from interface com.metamatrix.common.namedobject.BaseObject

clone, getFullName, getID

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

java.lang.String getName()

Returns the name

Specified by:

getName in interface BaseObject

Returns:

String name of component

See Also:

getFullName

getProperties

java.util.Properties getProperties()

Returns the current unmodifiable properties for the component

Returns:

Properties

getProperty

java.lang.String getProperty(java.lang.String name)

Returns a property value for the given property name

Parameters:

name - of the property value to obtain

Returns:

String property value

getComponentTypeID

ComponentTypeID getComponentTypeID()

Returns the component type

Returns:

ComponentType of this component

getDescription

java.lang.String getDescription()

Returns the description of this component definition

Returns:

String description of this component definition

getCreatedBy

java.lang.String getCreatedBy()

Returns the principal who created this type

Returns:

String principal name, or null if this object has only been created locally

getCreatedDate

java.util.Date getCreatedDate()

Returns the Date this type was created

Returns:

Date this type was created

getLastChangedBy

java.lang.String getLastChangedBy()

Returns the principal who last modified this type

Returns:

String principal name

getLastChangedDate

java.util.Date getLastChangedDate()

Returns the Date this type was last changed

Returns:

Date this type was last changed

isDependentUpon

boolean isDependentUpon(BaseID componentObjectId)

Returns true if this object is dependent upon the specified ComponentObjectID

Parameters:

componentObjectId - is the id to check for dependencies for

Returns:

boolean true if this object is dependent

accept

void accept(ConfigurationVisitor visitor)