|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PropertyDefinition
Information about a property of an AdminObject
Nested Class Summary | |
---|---|
static class |
PropertyDefinition.RestartType
|
Field Summary | |
---|---|
static int |
UNBOUNDED_VALUE
The value of the maximum multiplicity if the multiplicity is considered unbounded. |
Fields inherited from interface org.teiid.adminapi.AdminObject |
---|
DELIMITER, DELIMITER_CHAR, ESCAPED_DELIMITER, ESCAPED_WILDCARD, WILDCARD |
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. |
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. |
PropertyDefinition.RestartType |
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. |
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 |
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 |
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. |
Methods inherited from interface org.teiid.adminapi.AdminObject |
---|
getIdentifier, getName, getProperties, getPropertyValue |
Field Detail |
---|
static final int UNBOUNDED_VALUE
Method Detail |
---|
java.lang.String getValue()
java.lang.String getDisplayName()
java.lang.String getDescription()
java.lang.String getPropertyType()
java.lang.String getPropertyTypeClassName()
java.lang.Object getDefaultValue()
java.util.Collection getAllowedValues()
PropertyDefinition.RestartType getRequiresRestart()
boolean isModifiable()
boolean isConstrainedToAllowedValues()
getAllowedValues()
boolean isExpert()
boolean isRequired()
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.
boolean isMasked()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |