public interface IItem
This interface is not intended to be implemented by clients.
Modifier and Type | Method and Description |
---|---|
void |
delete()
Deletes the item.
|
String |
getAuditId()
All items stored in System Architect are tagged with the identity of the
person who created or last modified the item; the identity is tagged to the item as an
AuditId.
|
IEncyclopedia |
getEncyclopedia()
Returns the parent encyclopedia.
|
long |
getId()
Return the identity of the item.
|
String |
getName()
Returns the name of the item.
|
String |
getProperty(String name)
Returns the property content for any given item property.
|
<I extends IItem> |
getPropertyListOf(String name)
Returns the linked items for a list-of property.
|
IItem |
getPropertyOneOf(String name)
Returns the linked item for a one-of property.
|
long |
getTypeMinor()
Returns the constant integer of the type.
|
String |
getTypeName()
Returns the type of the item as a string, e.g.
|
void |
setName(String name)
Changes the name of an item.
|
void |
setProperty(String name,
String value)
The setting of an item property value requires the name of the property as the first
argument and the value to set as the second.
|
boolean |
setPropertyOneOf(String name,
IItem value)
Sets the new value for a one-of property.
|
IEncyclopedia getEncyclopedia()
String getAuditId()
long getId()
String getName()
void setName(String name)
In case of a definition, it might preferable to use the renameTo()
method which takes care of renaming the links and symbols
pointing to this definition.
name
- the new item's nameIDefinition.renameTo(String)
long getTypeMinor()
String getTypeName()
"Entity Relation"
.String getProperty(String name)
Oftentimes the real name of a property is not the same as what shows up on a definition dialog; for example, in an "Elementary Business Process" of a "Process Chart diagram", the "Locations" property is actually a rename � the real property is "Location Types". You would only know this if you looked up the definition of an "Elementary Business Process" in saprops.cfg and saw that the property is actually called "Location Types" but has been labeled "Locations"
name
- the Name of the property as seen in the saprops.cfg file.void setProperty(String name, String value)
Oftentimes the real name of a property is not the same as what shows up on a definition dialog; for example, in an "Elementary Business Process" of a "Process Chart diagram", the "Locations" property is actually a rename � the real property is "Location Types". You would only know this if you looked up the definition of an "Elementary Business Process" in saprops.cfg and saw that the property is actually called "Location Types" but has been labeled "Locations"
name
- the Name of the property as seen in the saprops.cfg file.value
- value of item property.IItem getPropertyOneOf(String name)
Oftentimes the real name of a property is not the same as what shows up on a definition dialog; for example, in an "Elementary Business Process" of a "Process Chart diagram", the "Locations" property is actually a rename � the real property is "Location Types". You would only know this if you looked up the definition of an "Elementary Business Process" in saprops.cfg and saw that the property is actually called "Location Types" but has been labeled "Locations"
name
- the Name of the property as seen in the saprops.cfg file.null
if none.boolean setPropertyOneOf(String name, IItem value)
Preconditions:
Oftentimes the real name of a property is not the same as what shows up on a definition dialog; for example, in an "Elementary Business Process" of a "Process Chart diagram", the "Locations" property is actually a rename � the real property is "Location Types". You would only know this if you looked up the definition of an "Elementary Business Process" in saprops.cfg and saw that the property is actually called "Location Types" but has been labeled "Locations"
name
- the Name of the property as seen in the saprops.cfg file.value
- the new item to link to, null
to unset the property.true
if the property was modified, false
otherwise.<I extends IItem> List<I> getPropertyListOf(String name)
Oftentimes the real name of a property is not the same as what shows up on a definition dialog; for example, in an "Elementary Business Process" of a "Process Chart diagram", the "Locations" property is actually a rename � the real property is "Location Types". You would only know this if you looked up the definition of an "Elementary Business Process" in saprops.cfg and saw that the property is actually called "Location Types" but has been labeled "Locations"
I
- the type of items in the returned list.name
- the Name of the property as seen in the saprops.cfg file.void delete()
Preconditions: