com.metamatrix.common.config.api
Interface ComponentDefn

All Superinterfaces:
BaseObject, java.lang.Cloneable, java.lang.Comparable, ComponentObject
All Known Subinterfaces:
AuthenticationProvider, ConnectorBinding, ExtensionModule, Host, ResourceDescriptor, ServiceComponentDefn, VMComponentDefn
All Known Implementing Classes:
BasicAuthenticationProvider, BasicComponentDefn, BasicConnectorBinding, BasicExtensionModule, BasicHost, BasicResourceDescriptor, BasicServiceComponentDefn, BasicVMComponentDefn

public interface ComponentDefn
extends ComponentObject


Field Summary
static int AUTHPROVIDER_COMPONENT_CODE
           
static int CONFIGURATION_COMPONENT_CODE
           
static int CONNECTOR_COMPONENT_CODE
           
static int DEPLOYED_COMPONENT_CODE
           
static int HOST_COMPONENT_CODE
           
static int PRODUCT_COMPONENT_CODE
           
static int RESOURCE_DESCRIPTOR_COMPONENT_CODE
           
static int SERVICE_COMPONENT_CODE
           
static int SHARED_RESOURCE_COMPONENT_CODE
           
static int VM_COMPONENT_CODE
           
 
Method Summary
 ConfigurationID getConfigurationID()
          Returns the ConfigurationID that identifies the configuation this component belongs to.
 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 interface com.metamatrix.common.config.api.ComponentObject
accept, getComponentTypeID, getCreatedBy, getCreatedDate, getDescription, getLastChangedBy, getLastChangedDate, getName, getProperties, getProperty, isDependentUpon
 
Methods inherited from interface com.metamatrix.common.namedobject.BaseObject
clone, getFullName, getID
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

CONFIGURATION_COMPONENT_CODE

static final int CONFIGURATION_COMPONENT_CODE
See Also:
Constant Field Values

SERVICE_COMPONENT_CODE

static final int SERVICE_COMPONENT_CODE
See Also:
Constant Field Values

CONNECTOR_COMPONENT_CODE

static final int CONNECTOR_COMPONENT_CODE
See Also:
Constant Field Values

PRODUCT_COMPONENT_CODE

static final int PRODUCT_COMPONENT_CODE
See Also:
Constant Field Values

VM_COMPONENT_CODE

static final int VM_COMPONENT_CODE
See Also:
Constant Field Values

RESOURCE_DESCRIPTOR_COMPONENT_CODE

static final int RESOURCE_DESCRIPTOR_COMPONENT_CODE
See Also:
Constant Field Values

HOST_COMPONENT_CODE

static final int HOST_COMPONENT_CODE
See Also:
Constant Field Values

SHARED_RESOURCE_COMPONENT_CODE

static final int SHARED_RESOURCE_COMPONENT_CODE
See Also:
Constant Field Values

DEPLOYED_COMPONENT_CODE

static final int DEPLOYED_COMPONENT_CODE
See Also:
Constant Field Values

AUTHPROVIDER_COMPONENT_CODE

static final int AUTHPROVIDER_COMPONENT_CODE
See Also:
Constant Field Values
Method Detail

getConfigurationID

ConfigurationID getConfigurationID()
Returns the ConfigurationID that identifies the configuation this component belongs to.

Returns:
ConfigurationID

isEnabled

boolean isEnabled()
Returns true if the component object is enabled for use.

Returns:
Since:
4.2

isEssential

boolean isEssential()
Indicates if this component is essenstial to the server running

Returns:
Since:
5.5


Copyright © 2009. All Rights Reserved.