com.metamatrix.common.config.model
Class BasicComponentDefn

java.lang.Object
  com.metamatrix.common.namedobject.BasicObject
      com.metamatrix.common.config.model.BasicComponentObject
          com.metamatrix.common.config.model.BasicComponentDefn

All Implemented Interfaces:

ComponentDefn, ComponentObject, BaseObject, PropertiedObject, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

Direct Known Subclasses:

BasicAuthenticationProvider, BasicExtensionModule, BasicHost, BasicResourceDescriptor, BasicServiceComponentDefn, BasicVMComponentDefn

public abstract class BasicComponentDefn
extends BasicComponentObject
implements ComponentDefn, java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.metamatrix.common.config.api.ComponentDefn

AUTHPROVIDER_COMPONENT_CODE, CONFIGURATION_COMPONENT_CODE, CONNECTOR_COMPONENT_CODE, DEPLOYED_COMPONENT_CODE, HOST_COMPONENT_CODE, PRODUCT_COMPONENT_CODE, RESOURCE_DESCRIPTOR_COMPONENT_CODE, SERVICE_COMPONENT_CODE, SHARED_RESOURCE_COMPONENT_CODE, VM_COMPONENT_CODE

Constructor Summary

protected	BasicComponentDefn(BasicComponentDefn component)
	BasicComponentDefn(ConfigurationID configurationID, ComponentDefnID componentID, ComponentTypeID typeID) Construct a BaseComponentDefn by providing the ConfigurationID the component belongs in and the ComponentDefnID that identifies this component and the ComponentType indicating the type of component.

Method Summary

ConfigurationID	getConfigurationID() Returns the ConfigurationID that identifies the configuation this component belongs to.
boolean	isDependentUpon(BaseID componentObjectId) Returns true if this object is dependent upon the specified ComponentObjectID
boolean	isEnabled() Returns true if the component object is enabled for use.
boolean	isEssential() Indicates if this component is essenstial to the server running

Methods inherited from class com.metamatrix.common.config.model.BasicComponentObject

accept, addProperties, addProperty, getComponentTypeID, getCreatedBy, getCreatedDate, getCreatedDateString, getDescription, getEditableProperties, getLastChangedBy, getLastChangedDate, getLastChangedDateString, getProperties, getProperty, removeProperties, removeProperty, setCreatedBy, setCreatedDate, setDescription, setLastChangedBy, setLastChangedDate, setProperties, toString

Methods inherited from class com.metamatrix.common.namedobject.BasicObject

clone, compareTo, equals, getFullName, getID, getName, hashCode, setID

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.metamatrix.common.config.api.ComponentObject

accept, getComponentTypeID, getCreatedBy, getCreatedDate, getDescription, getLastChangedBy, getLastChangedDate, getName, getProperties, getProperty

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

clone, getFullName, getID

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

BasicComponentDefn

public BasicComponentDefn(ConfigurationID configurationID,
                          ComponentDefnID componentID,
                          ComponentTypeID typeID)

Construct a BaseComponentDefn by providing the ConfigurationID the component belongs in and the ComponentDefnID that identifies this component and the ComponentType indicating the type of component.

Parameters:

configurationID - is the ConfigurationID

componentID - is the ComponentDefnId

type - is the ComponentType

BasicComponentDefn

protected BasicComponentDefn(BasicComponentDefn component)

Method Detail

getConfigurationID

public ConfigurationID getConfigurationID()

Description copied from interface: ComponentDefn

Returns the ConfigurationID that identifies the configuation this component belongs to.

Specified by:

getConfigurationID in interface ComponentDefn

Returns:

ConfigurationID

isDependentUpon

public boolean isDependentUpon(BaseID componentObjectId)

Description copied from interface: ComponentObject

Returns true if this object is dependent upon the specified ComponentObjectID

Specified by:

isDependentUpon in interface ComponentObject

Overrides:

isDependentUpon in class BasicComponentObject

Parameters:

componentObjectId - is the id to check for dependencies for

Returns:

boolean true if this object is dependent

isEnabled

public boolean isEnabled()

Returns true if the component object is enabled for use.

Specified by:

isEnabled in interface ComponentDefn

Returns:

Since:

4.2

isEssential

public boolean isEssential()

Description copied from interface: ComponentDefn

Indicates if this component is essenstial to the server running

Specified by:

isEssential in interface ComponentDefn

Returns: