com.metamatrix.common.config.api
Interface ComponentTypeDefn

All Superinterfaces:

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

All Known Implementing Classes:

BasicComponentTypeDefn

public interface ComponentTypeDefn
extends BaseObject

The ComponentTypeDefn is a definition defined for a specific ComponentType. One or more ComponentTypeDefns will be defined for a ComponentType.

Field Summary

static boolean

DEFAULT_IS_EFFECTIVE_IMMEDIATELY This is the default value for the effective immediately attribute of a ComponentTypeDefn.

Method Summary

java.util.List	getAllowedValues() Returns a list of PropDefnAllowedValue objects
PropertyDefinition	getClonedPropertyDefinition() Returns a modifiable PropertyDefinition.
ComponentTypeID	getComponentTypeID() Returns the id for ComponentType this definition applies to;
PropertyDefinition	getPropertyDefinition() Returns an unmodifiable PropertyDefinition
PropertyType	getPropertyType() Returns the property type
boolean	hasAllowedValues() Returns a boolean indicating if this definition has allowed values
boolean	isDeprecated() Returns boolean indicating if this type definition is deprecated or not
boolean	isEffectiveImmediately() Are changes to the property that this ComponentTypeDefn represents effective immediately or only on next startup of the server.
boolean	isRequired() Returns boolean indicating if this definition is required for this component type.

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

clone, getFullName, getID, getName

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

DEFAULT_IS_EFFECTIVE_IMMEDIATELY

static final boolean DEFAULT_IS_EFFECTIVE_IMMEDIATELY

This is the default value for the effective immediately attribute of a ComponentTypeDefn. It should be used to create a ComponentTypeDefn is the value is unknown.

See Also:

Constant Field Values

Method Detail

getComponentTypeID

ComponentTypeID getComponentTypeID()

Returns the id for ComponentType this definition applies to;

Returns:

ComponentTypeID

getPropertyDefinition

PropertyDefinition getPropertyDefinition()

Returns an unmodifiable PropertyDefinition

Returns:

unmodifiable PropertyDefinition

getClonedPropertyDefinition

PropertyDefinition getClonedPropertyDefinition()

Returns a modifiable PropertyDefinition. To save the changes made to the property definition, must call the modify method on the ObjectEditor.

Returns:

modifiable PropertyDefinition

hasAllowedValues

boolean hasAllowedValues()

Returns a boolean indicating if this definition has allowed values

Returns:

boolean of true if allowed values exist

getAllowedValues

java.util.List getAllowedValues()

Returns a list of PropDefnAllowedValue objects

Returns:

allowed values of type PropDefnAllowedValue

getPropertyType

PropertyType getPropertyType()

Returns the property type

Returns:

PropertyType

isDeprecated

boolean isDeprecated()

Returns boolean indicating if this type definition is deprecated or not

Returns:

boolean is true if this definition is deprecated

isRequired

boolean isRequired()

Returns boolean indicating if this definition is required for this component type.

Returns:

boolean is true is the definition is required

isEffectiveImmediately

boolean isEffectiveImmediately()

Are changes to the property that this ComponentTypeDefn represents effective immediately or only on next startup of the server.

Returns:

true if changes are effective immediately.