com.metamatrix.admin.objects
Class MMPropertyDefinition

java.lang.Object
  com.metamatrix.admin.objects.MMAdminObject
      com.metamatrix.admin.objects.MMPropertyDefinition

All Implemented Interfaces:

AdminObject, PropertyDefinition, java.io.Serializable

public class MMPropertyDefinition
extends MMAdminObject
implements PropertyDefinition

Since:

4.3

See Also:

Serialized Form

Field Summary

Fields inherited from class com.metamatrix.admin.objects.MMAdminObject

deployed, enabled, identifier, identifierParts, name, OBJECT_TYPE_CACHE, OBJECT_TYPE_CONNECTOR_BINDING, OBJECT_TYPE_CONNECTOR_TYPE, OBJECT_TYPE_DQP, OBJECT_TYPE_ENTITLEMENT, OBJECT_TYPE_EXTENSION_MODULE, OBJECT_TYPE_GROUP, OBJECT_TYPE_HOST, OBJECT_TYPE_LOG_CONFIGURATION, OBJECT_TYPE_MODEL, OBJECT_TYPE_PROCESS_OBJECT, OBJECT_TYPE_PROPERTY_DEFINITION, OBJECT_TYPE_QUEUE_WORKER_POOL, OBJECT_TYPE_REQUEST, OBJECT_TYPE_RESOURCE, OBJECT_TYPE_ROLE, OBJECT_TYPE_SESSION, OBJECT_TYPE_SOURCE_REQUEST, OBJECT_TYPE_SYSTEM_OBJECT, OBJECT_TYPE_USER, OBJECT_TYPE_VDB, OBJECTS_PACKAGE, registered, serialVersionUID

Fields inherited from interface com.metamatrix.admin.api.objects.PropertyDefinition

UNBOUNDED_VALUE

Fields inherited from interface com.metamatrix.admin.api.objects.AdminObject

DELIMITER, DELIMITER_CHAR, ESCAPED_DELIMITER, ESCAPED_WILDCARD, WILDCARD

Constructor Summary

MMPropertyDefinition(java.lang.String[] identifierParts)
Constructor.

Method Summary

java.util.Collection	getAllowedValues() Get the allowed values for this property.
java.lang.Object	getDefaultValue() Get the default value for values of this property, or an empty String if there is no default value.
java.lang.String	getDescription() Get the description of this property.
java.lang.String	getDisplayName() Get the localized display name of this property.
int	getMaximumMultiplicity() Get the maximum multiplicity for this property.
int	getMinimumMultiplicity() Get the minimum multiplicity for this property.
java.lang.String	getPropertyType() Get the type for values of this property.
java.lang.String	getPropertyTypeClassName() Get the name of the java class that best represents the property type.
boolean	getRequiresRestart() Get whether this property requires the system to be restarted before it takes effect.
java.lang.String	getValue() Get the current value of this property.
java.lang.String	getValueDelimiter() Return the text expression that is used to delimit multiple values within a single String value.
boolean	isConstrainedToAllowedValues() Return whether the value or values for this property are constrained to be only those in the AllowedValues list.
boolean	isExpert() The "expert" flag is used to distinguish between features that are intended for expert users from those that are intended for normal users.
boolean	isHidden() The "hidden" flag is used to identify features that are intended only for tool use, and which should not be exposed to humans.
boolean	isMasked() The "masked" flag is used to tell whether the value should be masked when displayed to users.
boolean	isModifiable() The modifiable flag is used to identify features that may not be changed once they are set.
boolean	isPreferred() The "preferred" flag is used to identify features that are particularly important for presenting to humans.
boolean	isRequired() The "required" flag is used to identify features that require at least one value (possibly a default value) by the consumer of the property.
void	setAllowedValues(java.util.Collection allowedValues)
void	setConstrainedToAllowedValues(boolean constrainedToAllowedValues)
void	setDefaultValue(java.lang.Object defaultValue)
void	setDescription(java.lang.String description)
void	setDisplayName(java.lang.String displayName)
void	setExpert(boolean expert)
void	setHidden(boolean hidden)
void	setMasked(boolean masked)
void	setMaximumMultiplicity(int maximumMultiplicity)
void	setMinimumMultiplicity(int minimumMultiplicity)
void	setModifiable(boolean modifiable)
void	setPreferred(boolean preferred)
void	setPropertyType(java.lang.String propertyTypeAsString)
void	setPropertyTypeClassName(java.lang.String propertyTypeClassName)
void	setRequired(boolean required)
void	setRequiresRestart(boolean requiresRestart)
void	setValue(java.lang.String value)
void	setValueDelimiter(java.lang.String valueDelimiter)
java.lang.String	toString() Get MetaMatrix Object as a String

Methods inherited from class com.metamatrix.admin.objects.MMAdminObject

buildIdentifier, buildIdentifierArray, buildIdentifierList, getCreated, getCreatedBy, getCreatedDate, getIdentifier, getIdentifierArray, getLastChangedBy, getLastChangedDate, getLastUpdated, getLastUpdatedBy, getName, getNameFromIdentifier, getObjectType, getParentName, getProperties, getPropertiesAsString, getPropertyValue, getProps, isDeployed, isEnabled, isRegistered, setCreated, setCreatedBy, setDeployed, setEnabled, setIdentifier, setLastUpdated, setLastUpdatedBy, setProperties, setRegistered

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.metamatrix.admin.api.objects.AdminObject

getIdentifier, getName, getProperties, getPropertyValue

Constructor Detail

MMPropertyDefinition

public MMPropertyDefinition(java.lang.String[] identifierParts)

Constructor.

Parameters:

identifierParts -

Since:

4.3

Method Detail

toString

public java.lang.String toString()

Description copied from class: MMAdminObject

Get MetaMatrix Object as a String

Specified by:

toString in class MMAdminObject

See Also:

Object.toString()

getValue

public java.lang.String getValue()

Description copied from interface: PropertyDefinition

Get the current value of this property.

Specified by:

getValue in interface PropertyDefinition

Returns:

the current value of this property.

Since:

4.3

See Also:

PropertyDefinition.getValue()

getAllowedValues

public java.util.Collection getAllowedValues()

Description copied from interface: PropertyDefinition

Get the allowed values for this property.

Specified by:

getAllowedValues in interface PropertyDefinition

Returns:

the list of allowed values for this property, or an empty set if the values do not have to conform to a fixed set.

Since:

4.3

See Also:

PropertyDefinition.getAllowedValues()

getDefaultValue

public java.lang.Object getDefaultValue()

Description copied from interface: PropertyDefinition

Get the default value for values of this property, or an empty String if there is no default value.

Specified by:

getDefaultValue in interface PropertyDefinition

Returns:

the default value for this property, or an empty String if there is no default value.

Since:

4.3

See Also:

PropertyDefinition.getDefaultValue()

getDescription

public java.lang.String getDescription()

Description copied from interface: PropertyDefinition

Get the description of this property.

Specified by:

getDescription in interface PropertyDefinition

Returns:

the description for this property

Since:

4.3

See Also:

PropertyDefinition.getDescription()

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: PropertyDefinition

Get the localized display name of this property.

Specified by:

getDisplayName in interface PropertyDefinition

Returns:

the displayable name for this property

Since:

4.3

See Also:

PropertyDefinition.getDisplayName()

getMaximumMultiplicity

public int getMaximumMultiplicity()

Description copied from interface: PropertyDefinition

Get the maximum multiplicity for this property.

Specified by:

getMaximumMultiplicity in interface PropertyDefinition

Returns:

the minimum multiplicity for this property. If the multiplicity is unbounded, this will return PropertyDefinition.UNBOUNDED_VALUE.

Since:

4.3

See Also:

PropertyDefinition.getMaximumMultiplicity()

getMinimumMultiplicity

public int getMinimumMultiplicity()

Description copied from interface: PropertyDefinition

Get the minimum multiplicity for this property.

Specified by:

getMinimumMultiplicity in interface PropertyDefinition

Returns:

the minimum multiplicity for this property.

Since:

4.3

See Also:

PropertyDefinition.getMinimumMultiplicity()

getPropertyType

public java.lang.String getPropertyType()

Description copied from interface: PropertyDefinition

Get the type for values of this property.

Specified by:

getPropertyType in interface PropertyDefinition

Returns:

the type that best describes the values of this property.

Since:

4.3

See Also:

PropertyDefinition.getPropertyType()

getPropertyTypeClassName

public java.lang.String getPropertyTypeClassName()

Description copied from interface: PropertyDefinition

Get the name of the java class that best represents the property type.

Specified by:

getPropertyTypeClassName in interface PropertyDefinition

Returns:

the name of the java class that best represents the property type.

Since:

4.3

See Also:

PropertyDefinition.getPropertyTypeClassName()

getRequiresRestart

public boolean getRequiresRestart()

Description copied from interface: PropertyDefinition

Get whether this property requires the system to be restarted before it takes effect.

Specified by:

getRequiresRestart in interface PropertyDefinition

Returns:

true if this property requires the system to be restarted before it takes effect.

Since:

4.3

See Also:

PropertyDefinition.getRequiresRestart()

getValueDelimiter

public java.lang.String getValueDelimiter()

Description copied from interface: PropertyDefinition

Return the text expression that is used to delimit multiple values within a single String value.

Specified by:

getValueDelimiter in interface PropertyDefinition

Returns:

the delimiter String; may be null only if the multiplicity has a maximum value of 1.

Since:

4.3

See Also:

PropertyDefinition.getValueDelimiter()

isConstrainedToAllowedValues

public boolean isConstrainedToAllowedValues()

Description copied from interface: PropertyDefinition

Return whether the value or values for this property are constrained to be only those in the AllowedValues list.

Specified by:

isConstrainedToAllowedValues in interface PropertyDefinition

Returns:

true if this property's value must be with the list of AllowedValues.

Since:

4.3

See Also:

PropertyDefinition.isConstrainedToAllowedValues()

isExpert

public boolean isExpert()

Description copied from interface: PropertyDefinition

The "expert" flag is used to distinguish between features that are intended for expert users from those that are intended for normal users.

Specified by:

isExpert in interface PropertyDefinition

Returns:

true if this property is to be marked with the expert flag, or false otherwise.

Since:

4.3

See Also:

PropertyDefinition.isExpert()

isHidden

public boolean isHidden()

Description copied from interface: PropertyDefinition

The "hidden" flag is used to identify features that are intended only for tool use, and which should not be exposed to humans.

Specified by:

isHidden in interface PropertyDefinition

Returns:

true if this property is marked with the hidden flag, or false otherwise.

Since:

4.3

See Also:

PropertyDefinition.isHidden()

isMasked

public boolean isMasked()

Description copied from interface: PropertyDefinition

The "masked" flag is used to tell whether the value should be masked when displayed to users.

Specified by:

isMasked in interface PropertyDefinition

Returns:

true if this property value is to be masked, or false otherwise.

Since:

4.3

See Also:

PropertyDefinition.isMasked()

isModifiable

public boolean isModifiable()

Description copied from interface: PropertyDefinition

The modifiable flag is used to identify features that may not be changed once they are set.

Specified by:

isModifiable in interface PropertyDefinition

Returns:

true if this property is marked with the modifyable flag, or false otherwise.

Since:

4.3

See Also:

PropertyDefinition.isModifiable()

isPreferred

public boolean isPreferred()

Description copied from interface: PropertyDefinition

The "preferred" flag is used to identify features that are particularly important for presenting to humans.

Specified by:

isPreferred in interface PropertyDefinition

Returns:

true if this property is marked with the preferred flag, or false otherwise.

Since:

4.3

See Also:

PropertyDefinition.isPreferred()

isRequired

public boolean isRequired()

Description copied from interface: PropertyDefinition

The "required" flag is used to identify features that require at least one value (possibly a default value) by the consumer of the property. Whether a property definition is required or not can be determined entirely from the multiplicity: if the multiplicity includes '0', then the property is not required.

Whether a property is required by the consumer is unrelated to whether there is a default value, which only simplifies the task of the property provider. A property may be required, meaning it must have at least one value, but that same property definition may or may not have a default. The combination of required and whether it has a default will determine whether the user must supply a value.

Specified by:

isRequired in interface PropertyDefinition

Returns:

true if this property requires at least one value.

Since:

4.3

See Also:

PropertyDefinition.isRequired()

setAllowedValues

public void setAllowedValues(java.util.Collection allowedValues)

Parameters:

allowedValues - The allowedValues to set.

Since:

4.3

setConstrainedToAllowedValues

public void setConstrainedToAllowedValues(boolean constrainedToAllowedValues)

Parameters:

constrainedToAllowedValues - The value of constrainedToAllowedValues to set.

Since:

4.3

setDefaultValue

public void setDefaultValue(java.lang.Object defaultValue)

Parameters:

defaultValue - The defaultValue to set.

Since:

4.3

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - The description to set.

Since:

4.3

setDisplayName

public void setDisplayName(java.lang.String displayName)

Parameters:

displayName - The displayName to set.

Since:

4.3

setExpert

public void setExpert(boolean expert)

Parameters:

expert - The value of expert to set.

Since:

4.3

setHidden

public void setHidden(boolean hidden)

Parameters:

hidden - The value of hidden to set.

Since:

4.3

setMasked

public void setMasked(boolean masked)

Parameters:

masked - The value of masked to set.

Since:

4.3

setMaximumMultiplicity

public void setMaximumMultiplicity(int maximumMultiplicity)

Parameters:

maximumMultiplicity - The maximumMultiplicity to set.

Since:

4.3

setMinimumMultiplicity

public void setMinimumMultiplicity(int minimumMultiplicity)

Parameters:

minimumMultiplicity - The minimumMultiplicity to set.

Since:

4.3

setModifiable

public void setModifiable(boolean modifiable)

Parameters:

modifiable - The value of modifiable to set.

Since:

4.3

setPreferred

public void setPreferred(boolean preferred)

Parameters:

preferred - The value of preferred to set.

Since:

4.3

setPropertyType

public void setPropertyType(java.lang.String propertyTypeAsString)

Parameters:

propertyTypeAsString - The propertyTypeAsString to set.

Since:

4.3

setPropertyTypeClassName

public void setPropertyTypeClassName(java.lang.String propertyTypeClassName)

Parameters:

propertyTypeClassName - The propertyTypeName to set.

Since:

4.3

setRequired

public void setRequired(boolean required)

Parameters:

required - The value of required to set.

Since:

4.3

setRequiresRestart

public void setRequiresRestart(boolean requiresRestart)

Parameters:

requiresRestart - The value of requiresRestart to set.

Since:

4.3

setValue

public void setValue(java.lang.String value)

Parameters:

value - The value to set.

Since:

4.3

setValueDelimiter

public void setValueDelimiter(java.lang.String valueDelimiter)

Parameters:

valueDelimiter - The valueDelimiter to set.

Since:

4.3