public interface IPropertyOwner extends INamedObject
Modifier and Type | Method and Description |
---|---|
void |
addProperty(Property newProp)
Add a named property to this object.
|
Property |
createProperty(PropertyDefinition propDef)
Create a property and add it to this object, using a property definition object.
|
java.util.List |
getAllProperties()
Get a list of all properties owned by this object, also all sub-properties
owned by those properties, if any.
|
boolean |
getBooleanPropertyValue(java.lang.String key)
A helper method to get the value of the property with the specified key name, and convert the value to
a boolean value if possible.
|
java.util.List |
getDisplayableProperties()
Get a list of properties that are not marked as hidden, and thus
will be displayed in the UI or console.
|
java.lang.String |
getDisplayableTypeName()
Get a displayable type name for the property owner object.
|
MapExpression |
getExpressionPropertyValue(java.lang.String key)
Gets a property value as an expression.
|
java.lang.Integer |
getIntPropertyValue(java.lang.String key)
A helper method to get the value of the property with the specified key name, and convert the value to
an integer value if possible.
|
java.util.List |
getProperties()
Get a list of all properties owned by this object.
|
Property |
getProperty(java.lang.String key)
Get the property object with the specified name.
|
java.lang.Object |
getPropertyValue(java.lang.String key)
Get the value of the property with the specified key name.
|
java.lang.String |
getStringPropertyValue(java.lang.String key)
Get the property value as a string.
|
boolean |
isPropertyDefined(java.lang.String key)
Return true if this property owner has a property with the specified key name, else false.
|
void |
setBooleanPropertyValue(java.lang.String key,
boolean value)
A helper method to set the value of the property with the specified key name,
and convert the specified value from a boolean to the actual persisted type if possible.
|
void |
setIntPropertyValue(java.lang.String key,
int value)
A helper method to set the value of the property with the specified key name,
and convert the specified value from an integer to the actual persisted type if possible.
|
void |
setPropertyValue(java.lang.String key,
java.lang.Object value)
Set a property value for the property with the specified key name.
|
getBusinessName, getDescription, getName, setBusinessName, setDescription, setName
dump, dump, getDisplayableObjectName, getGUID, getOwner, getStrongTypeClassName, validate, validate, validate
getRootContainer
getGlobalId, getInternalId, getSecurityContainer
java.util.List getProperties()
java.util.List getDisplayableProperties()
java.util.List getAllProperties()
java.lang.Object getPropertyValue(java.lang.String key) throws PropertyException
key
- The name of the property whose value to fetch.PropertyException
void setPropertyValue(java.lang.String key, java.lang.Object value) throws PropertyException
key
- The name of the property whose value will be set.value
- The object value of the property. The interpretation of the object
type will be determined by the type of the property.PropertyException
boolean getBooleanPropertyValue(java.lang.String key) throws PropertyException
key
- The name of the property.PropertyException
java.lang.Integer getIntPropertyValue(java.lang.String key) throws PropertyException
key
- The name of the property.int
value of the property.{@link
- PropertyException} will be thrown out if no such property with the specified key name defined.PropertyException
void setIntPropertyValue(java.lang.String key, int value) throws PropertyException
key
- The name of the property.value
- The int
value to which to set the property value.PropertyException
MapExpression getExpressionPropertyValue(java.lang.String key) throws PropertyException
key
- PropertyException
void setBooleanPropertyValue(java.lang.String key, boolean value) throws PropertyException
key
- The name of the property.value
- The boolean
value to which to set the property value.PropertyException
Property getProperty(java.lang.String key) throws PropertyException
key
- The key name of the property to be fetched.PropertyException
boolean isPropertyDefined(java.lang.String key) throws PropertyException
key
- The key name to check.PropertyException
void addProperty(Property newProp) throws PropertyException
newProp
- The property object to add to this object.PropertyException
Property createProperty(PropertyDefinition propDef) throws MappingException
propDef
- The property definition object.PropertyException
MappingException
PropertyDefinition
java.lang.String getDisplayableTypeName()
getDisplayableTypeName
in interface IRoot
java.lang.String getStringPropertyValue(java.lang.String key) throws PropertyException
PropertyException