com.metamatrix.common.config.api
Interface ComponentType

All Superinterfaces:

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

All Known Subinterfaces:

AuthenticationProviderType, ConnectorBindingType, HostType, ProductServiceConfigComponentType, ProductType, ResourceComponentType, ServiceComponentType, VMComponentDefnType

All Known Implementing Classes:

BasicAuthenticationProviderType, BasicComponentType, BasicConnectorBindingType, BasicHostType, BasicProductServiceConfigType, BasicProductType, BasicResourceComponentType, BasicServiceComponentType, BasicVMComponentDefnType

public interface ComponentType
extends BaseObject

Field Summary

static int	AUTHPROVIDER_COMPONENT_TYPE_CODE
static int	CONFIGURATION_COMPONENT_TYPE_CODE
static int	CONNECTOR_COMPONENT_TYPE_CODE
static int	DEPLOYED_COMPONENT_TYPE_CODE
static int	HOST_COMPONENT_TYPE_CODE
static int	PRODUCT_COMPONENT_TYPE_CODE
static int	PSC_COMPONENT_TYPE_CODE
static int	RESOURCE_COMPONENT_TYPE_CODE
static int	SERVICE_COMPONENT_TYPE_CODE
static int	VM_COMPONENT_TYPE_CODE

Method Summary

void	accept(ConfigurationVisitor visitor)
int	getComponentTypeCode() Returns int indicating the component type code;
ComponentTypeDefn	getComponentTypeDefinition(java.lang.String name) Returns the ComponentTypeDefn for the specified name
java.util.Collection	getComponentTypeDefinitions() Returns the Collection of ComponentTypeDefns that are defined for this component type
java.lang.String	getCreatedBy() Returns the principal who created this type
java.util.Date	getCreatedDate() Returns a string version of the Date this type was created
java.util.Properties	getDefaultPropertyValues() Returns the default values for this component type.
java.lang.String	getDefaultValue(java.lang.String propertyName) Returns the String representation of the default value for the requested property.
java.lang.String	getDescription() Returns the description, if it has one, of the component type
java.lang.String	getLastChangedBy() Returns the principal who last modified this type
java.util.Date	getLastChangedDate() Returns a string version of the this type was last changed
java.util.Collection	getMaskedPropertyNames() Returns the List of properties that are defined as masked for this component type.
ComponentTypeID	getParentComponentTypeID() Returns the parent component type id
ComponentTypeID	getSuperComponentTypeID() Returns the super component type id
boolean	isDeployable() Returns true is the component type is considered deployable within a configuration.
boolean	isDeprecated() Returns true if this component type is no longer used
boolean	isMonitored() Returns true if this component type is monitored
boolean	isOfConnectorProductType() Returns true if this component type is a member of the connectors product type based on
boolean	isOfTypeConnector() Returns true if this component type is a connector type
boolean	isOfTypeXAConnector() Returns true if this component type is a XA connector type.

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

clone, getFullName, getID, getName

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

CONFIGURATION_COMPONENT_TYPE_CODE

static final int CONFIGURATION_COMPONENT_TYPE_CODE

See Also:

Constant Field Values

SERVICE_COMPONENT_TYPE_CODE

static final int SERVICE_COMPONENT_TYPE_CODE

See Also:

Constant Field Values

CONNECTOR_COMPONENT_TYPE_CODE

static final int CONNECTOR_COMPONENT_TYPE_CODE

See Also:

Constant Field Values

PRODUCT_COMPONENT_TYPE_CODE

static final int PRODUCT_COMPONENT_TYPE_CODE

See Also:

Constant Field Values

RESOURCE_COMPONENT_TYPE_CODE

static final int RESOURCE_COMPONENT_TYPE_CODE

See Also:

Constant Field Values

VM_COMPONENT_TYPE_CODE

static final int VM_COMPONENT_TYPE_CODE

See Also:

Constant Field Values

PSC_COMPONENT_TYPE_CODE

static final int PSC_COMPONENT_TYPE_CODE

See Also:

Constant Field Values

HOST_COMPONENT_TYPE_CODE

static final int HOST_COMPONENT_TYPE_CODE

See Also:

Constant Field Values

DEPLOYED_COMPONENT_TYPE_CODE

static final int DEPLOYED_COMPONENT_TYPE_CODE

See Also:

Constant Field Values

AUTHPROVIDER_COMPONENT_TYPE_CODE

static final int AUTHPROVIDER_COMPONENT_TYPE_CODE

See Also:

Constant Field Values

Method Detail

getComponentTypeDefinitions

java.util.Collection getComponentTypeDefinitions()

Returns the Collection of ComponentTypeDefns that are defined for this component type

Returns:

Set of ComponentTypeDefn

getComponentTypeDefinition

ComponentTypeDefn getComponentTypeDefinition(java.lang.String name)

Returns the ComponentTypeDefn for the specified name

Returns:

ComponentTypeDefn of ComponentTypeDefn

getDefaultPropertyValues

java.util.Properties getDefaultPropertyValues()

Returns the default values for this component type. Note, it does not return the defaults from its super component type. To obtain all default properties, call

Returns:

Since:

4.3

getMaskedPropertyNames

java.util.Collection getMaskedPropertyNames()

Returns the List of properties that are defined as masked for this component type.

getDefaultValue

java.lang.String getDefaultValue(java.lang.String propertyName)

Returns the String representation of the default value for the requested property.

Parameters:

propertyName -

Returns:

Since:

4.2

getParentComponentTypeID

ComponentTypeID getParentComponentTypeID()

Returns the parent component type id

Returns:

ComponentType parent

getSuperComponentTypeID

ComponentTypeID getSuperComponentTypeID()

Returns the super component type id

Returns:

ComponentType parent

getComponentTypeCode

int getComponentTypeCode()

Returns int indicating the component type code;

Returns:

int

isDeployable

boolean isDeployable()

Returns true is the component type is considered deployable within a configuration.

Returns:

boolean true if the component type is deployable

isDeprecated

boolean isDeprecated()

Returns true if this component type is no longer used

Returns:

boolean true if deprecated

isMonitored

boolean isMonitored()

Returns true if this component type is monitored

Returns:

boolean true if monitored

isOfConnectorProductType

boolean isOfConnectorProductType()

Returns true if this component type is a member of the connectors product type based on

Returns:

boolean true if a member of the connectors product type

isOfTypeConnector

boolean isOfTypeConnector()

Returns true if this component type is a connector type

Returns:

boolean true if a connector type

isOfTypeXAConnector

boolean isOfTypeXAConnector()

Returns true if this component type is a XA connector type. If this is true, then @link #isOfTypeConnector() will also be true. However, @link #isOfTypeConnector() can be true and this can be false.

Returns:

boolean true if a connector type

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 a string version of the Date this type was created

Returns:

Date this type was created, or null if this object has only been created locally

getLastChangedBy

java.lang.String getLastChangedBy()

Returns the principal who last modified this type

Returns:

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

getLastChangedDate

java.util.Date getLastChangedDate()

Returns a string version of the this type was last changed

Returns:

Date this type was last changed, or null if this object has only been created locally

getDescription

java.lang.String getDescription()

Returns the description, if it has one, of the component type

Returns:

String description

Since:

4.2

accept

void accept(ConfigurationVisitor visitor)