com.metamatrix.common.config.model
Class BasicComponentTypeDefn

java.lang.Object
  com.metamatrix.common.namedobject.BasicObject
      com.metamatrix.common.config.model.BasicComponentTypeDefn

All Implemented Interfaces:

ComponentTypeDefn, BaseObject, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class BasicComponentTypeDefn
extends BasicObject
implements ComponentTypeDefn

See Also:

Serialized Form

Field Summary

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

DEFAULT_IS_EFFECTIVE_IMMEDIATELY

Constructor Summary

BasicComponentTypeDefn(ComponentTypeDefnID id, ComponentTypeID typeID, PropertyDefinition propertyDefinition, boolean deprecated)
Deprecated. as of 2.0 beta 1, use BasicComponentTypeDefn

BasicComponentTypeDefn(ComponentTypeDefnID id, ComponentTypeID typeID, PropertyDefinition propertyDefinition, boolean deprecated, boolean effectiveImmediately)

Method Summary

java.lang.Object	clone() Return a deep cloned instance of this object.
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 class com.metamatrix.common.namedobject.BasicObject

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

Methods inherited from class java.lang.Object

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

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

getFullName, getID, getName

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

BasicComponentTypeDefn

public BasicComponentTypeDefn(ComponentTypeDefnID id,
                              ComponentTypeID typeID,
                              PropertyDefinition propertyDefinition,
                              boolean deprecated,
                              boolean effectiveImmediately)

BasicComponentTypeDefn

public BasicComponentTypeDefn(ComponentTypeDefnID id,
                              ComponentTypeID typeID,
                              PropertyDefinition propertyDefinition,
                              boolean deprecated)

Deprecated. as of 2.0 beta 1, use BasicComponentTypeDefn

This constructor is deprecated as of 2.0. should try to use constructor with effectiveImmediately.

Method Detail

getComponentTypeID

public ComponentTypeID getComponentTypeID()

Description copied from interface: ComponentTypeDefn

Returns the id for ComponentType this definition applies to;

Specified by:

getComponentTypeID in interface ComponentTypeDefn

Returns:

ComponentTypeID

getPropertyDefinition

public PropertyDefinition getPropertyDefinition()

Description copied from interface: ComponentTypeDefn

Returns an unmodifiable PropertyDefinition

Specified by:

getPropertyDefinition in interface ComponentTypeDefn

Returns:

unmodifiable PropertyDefinition

getClonedPropertyDefinition

public PropertyDefinition getClonedPropertyDefinition()

Description copied from interface: ComponentTypeDefn

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

Specified by:

getClonedPropertyDefinition in interface ComponentTypeDefn

Returns:

modifiable PropertyDefinition

getPropertyType

public PropertyType getPropertyType()

Description copied from interface: ComponentTypeDefn

Returns the property type

Specified by:

getPropertyType in interface ComponentTypeDefn

Returns:

PropertyType

isDeprecated

public boolean isDeprecated()

Description copied from interface: ComponentTypeDefn

Returns boolean indicating if this type definition is deprecated or not

Specified by:

isDeprecated in interface ComponentTypeDefn

Returns:

boolean is true if this definition is deprecated

isRequired

public boolean isRequired()

Description copied from interface: ComponentTypeDefn

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

Specified by:

isRequired in interface ComponentTypeDefn

Returns:

boolean is true is the definition is required

isEffectiveImmediately

public boolean isEffectiveImmediately()

Description copied from interface: ComponentTypeDefn

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

Specified by:

isEffectiveImmediately in interface ComponentTypeDefn

Returns:

true if changes are effective immediately.

hasAllowedValues

public boolean hasAllowedValues()

Description copied from interface: ComponentTypeDefn

Returns a boolean indicating if this definition has allowed values

Specified by:

hasAllowedValues in interface ComponentTypeDefn

Returns:

boolean of true if allowed values exist

getAllowedValues

public java.util.List getAllowedValues()

Description copied from interface: ComponentTypeDefn

Returns a list of PropDefnAllowedValue objects

Specified by:

getAllowedValues in interface ComponentTypeDefn

Returns:

allowed values of type PropDefnAllowedValue

clone

public java.lang.Object clone()

Return a deep cloned instance of this object. Subclasses must override this method.

Specified by:

clone in interface BaseObject

Overrides:

clone in class BasicObject

Returns:

the object that is the clone of this instance.