Interface IDefinition

  • All Superinterfaces:
    IItem

    public interface IDefinition
    extends IItem
    Represents a definition in a System Architect encyclopedia.

    This interface is not intended to be implemented by clients.

    Since:
    2.2.0
    See Also:
    IEncyclopedia.getDefinitions()
    • Method Detail

      • getXML

        String getXML()
        Returns the XML content of the definition.
        Returns:
        the XML content of the definition.
      • renameTo

        void renameTo​(String name)
        Opens the definition edit dialog in the System Architect application to perform the rename. This method ensures that all links and symbols pointing to this definition are correctly updated. The edit dialog is automatically closed when this method completes.
        Parameters:
        name - the new definition name.
      • isLocked

        boolean isLocked()
        Check if the definition is locked by the application.
        Returns:
        true if and only if the definition is locked by the application; false otherwise.
        Since:
        2.2.2
      • unlock

        void unlock()
        Unlock the definition in the application.
        Since:
        2.2.2