Interface IMetaProperty
-
public interface IMetaProperty
The MetaProperty object allows you to retrieve information about each property of a specific object in the encyclopedia. This object corresponds to the Property keyword in saprops.cfg and usrprops.txt filesThis interface is not intended to be implemented by clients.
- Since:
- 2.2.0
- See Also:
IMetaItem.getMetaProperties()
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getAltLabelLong()
The Alternative System Architect long label for the property.String
getAltLabelShort()
The Alternative System Architect short label for the property.String
getDefault()
The default value set for the property on first use.long
getEditFlags()
The number of properties that must be filled in for a property.long
getEditLength()
The edit length of the property.String
getEditType()
The edit type of the property.long
getEditTypeNum()
The edit type numerical constant of the property.String
getHelp()
The help text set for this property.IMetaItem
getInheritedPropertyFrom()
List<IMetaKeyedBy>
getKeyedBy()
The property is keyed by another property or not.String
getLabel()
The standard System Architect label for the property.IMetaList
getList()
Returns MetaList enumeration defines the possible choices for the property value.IMetaItem
getMetaItem()
Provides access to the parent MetaItem object.String
getName()
The name of the property.long
getOfFlags()
The number of flags for the property.long
getOfMajorType()
The numerical constant of the parent objects class.String
getOfMajorTypeName()
The type name of the parent objects class.long
getOfMinorType()
The current parent objects numerical type constant.String
getOfMinorTypeName()
The current parent objects type name.long
getOfRelateType()
The parent objects relationship numberlong
getRangeMax()
The maximum edit range value.long
getRangeMin()
The minimum edit range value.long
getRequired()
The required property for the object.long
getTypeNumber()
The type number of the parent object.boolean
isKey()
Whether the property is a key or not.
-
-
-
Method Detail
-
getMetaItem
IMetaItem getMetaItem()
Provides access to the parent MetaItem object.- Returns:
- the parent MetaItem object.
-
getAltLabelLong
String getAltLabelLong()
The Alternative System Architect long label for the property.- Returns:
- the Alternative System Architect long label for the property.
-
getAltLabelShort
String getAltLabelShort()
The Alternative System Architect short label for the property.- Returns:
- the Rational System Architect short label for the property
-
getDefault
String getDefault()
The default value set for the property on first use.- Returns:
- the default value set for the property on first use.
-
getEditFlags
long getEditFlags()
The number of properties that must be filled in for a property.- Returns:
- the number of properties that must be filled in for a property.
-
getEditLength
long getEditLength()
The edit length of the property.- Returns:
- the edit length of the property.
-
getEditType
String getEditType()
The edit type of the property.- Returns:
- the edit type of the property.
-
getEditTypeNum
long getEditTypeNum()
The edit type numerical constant of the property.- Returns:
- the edit type numerical constant of the property.
-
getHelp
String getHelp()
The help text set for this property.- Returns:
- the help text set for this property.
-
getKeyedBy
List<IMetaKeyedBy> getKeyedBy()
The property is keyed by another property or not.- Returns:
- the list of is keyed by.
-
getLabel
String getLabel()
The standard System Architect label for the property.- Returns:
- the standard System Architect label for the property.
-
getName
String getName()
The name of the property.- Returns:
- the name of the property.
-
getOfFlags
long getOfFlags()
The number of flags for the property.- Returns:
- the number of flags for the property.
-
getOfMajorType
long getOfMajorType()
The numerical constant of the parent objects class.- Returns:
- the numerical constant of the parent objects class.
-
getOfMajorTypeName
String getOfMajorTypeName()
The type name of the parent objects class.- Returns:
- the type name of the parent objects class.
-
getOfMinorType
long getOfMinorType()
The current parent objects numerical type constant.- Returns:
- the current parent objects numerical type constant.
-
getOfMinorTypeName
String getOfMinorTypeName()
The current parent objects type name.- Returns:
- the current parent objects type name.
-
getOfRelateType
long getOfRelateType()
The parent objects relationship number- Returns:
- rhe parent objects relationship number
-
getRangeMax
long getRangeMax()
The maximum edit range value.- Returns:
- the maximum edit range value.
-
getRangeMin
long getRangeMin()
The minimum edit range value.- Returns:
- the minimum edit range value.
-
getRequired
long getRequired()
The required property for the object.- Returns:
- the required property for the object.
-
isKey
boolean isKey()
Whether the property is a key or not.- Returns:
- a boolean indicating whether the property is a key or not.
-
getTypeNumber
long getTypeNumber()
The type number of the parent object.- Returns:
- the type number of the parent object.
-
getInheritedPropertyFrom
IMetaItem getInheritedPropertyFrom()
-
getList
IMetaList getList()
Returns MetaList enumeration defines the possible choices for the property value.- Returns:
- the type number of the parent object.
- Since:
- 2.3.0
-
-