Interface IItem
-
- All Known Subinterfaces:
IDefinition
,IDiagram
,ISymbol
public interface IItem
An item that is identified in the System Architect data dictionary.This interface is not intended to be implemented by clients.
- Since:
- 2.2.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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>
List<I>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.
-
-
-
Method Detail
-
getEncyclopedia
IEncyclopedia getEncyclopedia()
Returns the parent encyclopedia.- Returns:
- the parent encyclopedia.
-
getAuditId
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.- Returns:
- the identity of the person who created or last modified the item
-
getId
long getId()
Return the identity of the item.- Returns:
- the identity of the item.
-
getName
String getName()
Returns the name of the item.- Returns:
- the name of the item.
-
setName
void setName(String name)
Changes the name of an item.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.- Parameters:
name
- the new item's name- See Also:
IDefinition.renameTo(String)
-
getTypeMinor
long getTypeMinor()
Returns the constant integer of the type. All types in System Architect have a unique numerical constant identifier.- Returns:
- the constant integer of the type.
-
getTypeName
String getTypeName()
Returns the type of the item as a string, e.g."Entity Relation"
.- Returns:
- the type of the item as a string
-
getProperty
String getProperty(String name)
Returns the property content for any given item property.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"
- Parameters:
name
- the Name of the property as seen in the saprops.cfg file.- Returns:
- the property content for the given item property.
-
setProperty
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. The property names are found in the saprops.cfg and usrprops.txt files.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"
- Parameters:
name
- the Name of the property as seen in the saprops.cfg file.value
- value of item property.
-
getPropertyOneOf
IItem getPropertyOneOf(String name)
Returns the linked item for a one-of property.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"
- Parameters:
name
- the Name of the property as seen in the saprops.cfg file.- Returns:
- the linked item,
null
if none.
-
setPropertyOneOf
boolean setPropertyOneOf(String name, IItem value)
Sets the new value for a one-of property.Preconditions:
- The underlying item was obtained in read-only mode
- The specified value was obtained in read-only mode
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"
- Parameters:
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.- Returns:
true
if the property was modified,false
otherwise.
-
getPropertyListOf
<I extends IItem> List<I> getPropertyListOf(String name)
Returns the linked items for a list-of property.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"
- Type Parameters:
I
- the type of items in the returned list.- Parameters:
name
- the Name of the property as seen in the saprops.cfg file.- Returns:
- the linked items.
-
delete
void delete()
Deletes the item.Preconditions:
- The underlying item was obtained in read-only mode
-
-